Skip to main content

API Overview

All HTTP routes live under /api/v1. The full OpenAPI schema is auto-generated by FastAPI and available at:

The pages in this section group endpoints by resource and document what each one does, the request shape, and the auth requirements.

Auth

Almost every route requires a bearer token in the Authorization header:

Authorization: Bearer <jwt-or-api-key>

JWT tokens are issued by /auth/login. API keys are created via the Settings page or admin endpoints and start with wld_.

Conventions

  • IDs are UUIDv4 strings.
  • Timestamps are ISO-8601 in UTC.
  • Pagination uses ?offset= and ?limit= query params on list endpoints.
  • Errors return {"detail": "..."} JSON with an appropriate HTTP status.

Resource map

GroupPath prefixPages
Auth/auth/*Auth
Upload + Projects/upload, /projectsUpload
Labeling/label/*Label
Review/jobs/*, /annotations/*Review
Training/train/*, /models/*Train
Serving/predict/*, /serve/*, /endpoints/*Serve
Workflows/workflows/*Workflows
Admin/admin/*Admin