Endpoint overview
All v1 endpoints and machine-readable contracts for agent integrations.
Base URL: https://api.beatra.ai/v1 · For authentication and common headers, see Authentication & request conventions.
Use this page as the human index. Agents should ingest the machine-readable contracts below and link back to the operation pages for parameter details.
Endpoints
| Method | Path | Description | Mode |
|---|---|---|---|
| GET | /v1/models | Model list (OpenAI-compatible) | Sync |
| GET | /v1/catalog/models | Model catalog (with capability metadata) | Sync |
| GET | /v1/catalog/capabilities | Capability catalog | Sync |
| GET | /v1/catalog/capabilities/{capability} | Capability detail with per-model parameters and prices | Sync |
| GET | /v1/catalog/models/{model} | Model detail with supported capabilities and prices | Sync |
| POST | /v1/images/generations | Text to image | Async |
| POST | /v1/images/image-to-image | Image to image | Async |
| POST | /v1/images/edits | Image editing | Async |
| POST | /v1/videos/text-to-video | Text to video | Async |
| POST | /v1/videos/image-to-video | Image to video | Async |
| POST | /v1/videos/reference-to-video | Reference to video | Async |
| POST | /v1/videos/frames-to-video | Frames to video | Async |
| POST | /v1/videos/edit | Instruction and reference-guided video editing | Async |
| POST | /v1/videos/extend | Continue a source video beyond its endpoint | Async |
| POST | /v1/audio/speech | Text to speech | Async |
| POST | /v1/voices | Voice clone | Async |
| GET | /v1/voices | List voices | Sync |
| GET | /v1/voices/{voice_id} | Voice details | Sync |
| DELETE | /v1/voices/{voice_id} | Delete voice | Sync |
| POST | /v1/music/text-to-music | Text to music | Async |
| POST | /v1/music/reference-audio-to-music | Reference audio to music | Async |
| POST | /v1/uploads | Upload source media (≤100MB, returns artifact_id) | Sync |
| GET | /v1/tasks | Task list (cursor pagination) | Sync |
| GET | /v1/tasks/{task_id} | Task details (full envelope) | Sync |
| POST | /v1/tasks/{task_id}/cancel | Cancel task (idempotent) | Sync |
| GET | /v1/health | Health check | Sync |
Parameter-level contracts are generated from OpenAPI; reach them via the "API definition" links on each capability page.
Machine-readable
- OpenAPI YAML · OpenAPI JSON
- llms.txt — index of integration material for AI coding assistants
- MCP metadata — active OAuth MCP runtime with upload, image, video, music, speech, voice, model, and task tools — see the Quickstart