Endpoint reference
The whole surface at a glance. Every endpoint authenticates with a bearer key; the required scope is in parentheses.
Text
| Endpoint | Purpose |
|---|---|
| POST /v1/chat/completions (CHAT) | OpenAI-compatible chat completion; streaming optional |
| POST /v1/completions (COMPLETIONS) | Legacy text completion |
| POST /v1/responses (RESPONSES) | Stateless responses API |
| POST /v1/embeddings (EMBEDDINGS) | Embedding vectors |
Media jobs
| Endpoint | Purpose |
|---|---|
| POST /v1/images/generations (IMAGES) | Image generation job |
| POST /v1/videos (VIDEOS) | Video generation job |
| POST /v1/audio/speech (AUDIO_SPEECH) | Text-to-speech job |
| POST /v1/audio/transcriptions (AUDIO_TRANSCRIPTIONS) | Speech-to-text job |
| POST /v1/audio/generations (AUDIO_GENERATIONS) | Audio generation job |
| POST /v1/music/generations (MUSIC) | Music generation job |
| POST /v1/workflows (WORKFLOWS) | ComfyUI workflow-graph job |
| GET /v1/jobs | List recent jobs |
| GET /v1/jobs/{id} | Poll job status, cost and artifacts |
| DELETE /v1/jobs/{id} | Cancel a running job |
| GET /v1/artifacts/{id} | Download a job artifact (kept 30 days) |
Catalog and usage
| Endpoint | Purpose |
|---|---|
| GET /v1/models | Public model catalog with prices and availability (no auth) |
| GET /v1/models/by-id?id={id} | Model detail: pricing, parameters, request contracts |
| GET /v1/models/by-id/stats?id={id} | Throughput and latency statistics |
| GET /v1/models/by-id/activity?id={id} | Recent request activity |
| GET /v1/models/by-id/availability?id={id} | Provider availability history |
| GET /v1/models/by-id/pricing-history?id={id} | Every published price version |
| GET /v1/requests/{id} | Settled usage, cost and receipt for one request |
Pass the exact model id, including vendor/model slashes, in the id query parameter.
Conventions
- An Idempotency-Key header makes POST retries safe.
- The x-request-id response header identifies every request.
- Hitting the rate limit returns 429 with Retry-After seconds.
- Errors are a JSON envelope with a stable code.
- Amounts are USD; the ledger uses micro-USD strings (1,000,000 = $1).
https://api.openmayhem.ai/v1