Compeller v1 API
API by Compeller AI · rest
Agent-first REST API for the Compeller platform. This spec is the source of truth for the implemented /api/v1/* surface. The HTML landing page at /api/docs is a marketing page and is not authoritative - integrate against this spec. Per-song end-to-end flow 1. If you have an MP3/WAV/FLAC, POST /api/v1/media as multipart/form-data, then POST /api/v1/compels with primary_media_id set to that media id. If you only have a song/artist string, use GET /api/v1/music/search followed by POST /api/v1/compels/from-music; from-music defaults to auto_start: true and will continue into rendering automatically unless you send auto_start: false. 2. For uploaded-audio compels, GET /api/v1/compels/{id} or the returned events_url until the compel reaches stage: READY, then follow next_action. 3. POST /api/v1/compels/{id}/start-render to use Compeller defaults / surprise-me configuration and begin rendering when next_action asks for it. 4. Poll GET…
Endpoint: https://compeller.ai/
Verification: observed. Source: crawl.
Capabilities (50)
- Existing login endpoint that returns an access_token accepted by v1 and MCP…
- Self-serve agent signup. Creates one Compeller account and returns an…
- Login with Compeller credentials and return the user's API token.
- List platform capabilities.
- List compels owned by the authenticated account newest first.
- Create a compel generation job.
- Create a compel from a selected Deezer preview track.
- Fetch a single compel by id.
- Cancel a compel.
- Cancel a compel (explicit POST alias for `DELETE /api/v1/compels/{id}`).
- List lifecycle events for a compel.
- List all renderings for a compel.
- Start or retry rendering for a compel using Compeller defaults.
- Lightweight API health check for agents and SDKs.
- Describe accepted input formats.
- List COM-494 fixture capability snapshots.
- Fetch one COM-494 fixture capability snapshot by profile id.
- List active live lighting cue metadata.
- Create a live lighting cue launch intent.
- Fetch one live lighting cue metadata record.
- REACT/BAE acknowledgement for one live lighting cue.
- REACT/BAE status report-back for one live lighting cue.
- Request stop for one live lighting cue.
- Update live cue variables.
- List COM-497 starter CueProfiles.