FOCUSCurrently working on ScheduleSomething and LayerdEvents algorithmsLearn More
FOCUSCurrently working on ScheduleSomething and LayerdEvents algorithmsLearn More
FOCUSCurrently working on ScheduleSomething and LayerdEvents algorithmsLearn More
FOCUSCurrently working on ScheduleSomething and LayerdEvents algorithmsLearn More
DevelopmentAPI Reference
API Overview & Conventions
DocsdevelopmentAPI ReferenceAPI Overview & Conventions
GitHub Live Sync

API Overview & Conventions

Live technical documentation fetched from GitHub repository omghante/metapilot/docs/api/overview.md

REST API Overview & Design Specification

MetaPilot provides a JSON-based RESTful API powered by Django REST Framework (DRF) and documented via OpenAPI 3.0 (
drf-spectacular
).

Interactive API Documentation (Swagger / ReDoc)

When running the backend server locally (
./scripts/backend.sh
):
  • Swagger UI:
    http://localhost:8000/api/schema/swagger-ui/
  • ReDoc UI:
    http://localhost:8000/api/schema/redoc/
  • OpenAPI Schema (JSON):
    http://localhost:8000/api/schema/

Common HTTP Headers

Header NameMandatory?Value / FormatPurpose
Authorization
Yes (except login)
Bearer <JWT_ACCESS_TOKEN>
Authenticates caller
X-Tenant-ID
Yes (Tenant endpoints)
UUID
string
Resolves tenant scope for multi-tenant isolation
Content-Type
Yes
application/json
Specifies request body payload format
Accept
Yes
application/json
Specifies expected response format