Skip to main content
Overmind Cloud uses https://api.overmindlab.ai as its API base. For self-hosting, use your installation’s API address. Each server publishes its own OpenAPI schema at the paths below. Use this after connecting Overmind. Supply or select the named resource in your conversation; the agent reads the contract rather than guessing IDs. The deployed schema is authoritative for request/response fields. The endpoint index below names resource families, not every custom action. MCP uses the same domain services through purpose-built tools.

Authentication

API keys use X-Api-Key, Authorization: Bearer or Authorization: Api-Key. Account scope reaches authorized projects; project scope is restricted to one. Select the project using each endpoint’s declared query/body field. The hosted Console uses Clerk when configured. Local email/password login is POST /api/auth/local/, with create-on-first-use and no email verification. JWT token/refresh endpoints also exist. MCP OAuth tokens are specific to MCP and are not ordinary REST/CLI credentials. API keys are managed under /api/auth/api-keys/, with calling-key inspection at /api/auth/api-keys/current/. Plaintext keys are returned only at creation. Guest sessions are read/claim-only unless an endpoint explicitly permits the requested guest write.

Core and observability

Trace list/detail are backed by spans, not a separate Trace table. The current API has no task-execution, behaviour or verdict resource families.

Data and preparation

Dataset actions expose source/cell inspection, rows, export, workbench and pipeline execution. New recipes require a retained package. Use the CLI for local byte transfer rather than manually reconstructing its resumable protocol.

Evaluation, training and serving

Read the operation schema to distinguish saving, preparation and launch. A saved training experiment or native comparison draft does not start provider work.

Errors and pagination

DRF lists generally return count, next, previous and results; custom evidence endpoints may use offset/cursor contracts. Follow the returned pagination rather than assuming the first response is complete. Typical status classes are 401 for authentication, 403 for permission, 404 for absent or inaccessible resources, 409 for identity/revision conflicts and 402 for insufficient credits where billing gates apply. Field validation and workflow errors include details to inspect before retrying. Use a stable request key where an operation supports it. Do not assume a repeated POST is harmless on operations without that contract.