Want to make music videos or live visuals programmatically? You are in the right place. Compeller exposes a REST API, an MCP endpoint for agent integrators, and webhook callbacks for lifecycle events.
What is a compel?
A Compel is a music-driven video/visual project.
To make a video for a song: create or select a Compel, configure the style and treatment, generate scenes and renderings, then download the result or receive webhook callbacks.
For agents
If a user asks you to make a music video with Compeller, start by
reading this page, then use the REST API, OpenAPI spec, or MCP
endpoint linked below. Read
https://compeller.ai/for-agents for the
full integration guide,
https://compeller.ai/agents.json for a
machine-readable manifest, and
https://compeller.ai/llms.txt for a plain-text
digest aimed at LLM crawlers.
| Purpose | Endpoint |
|---|---|
| REST API base | https://compeller.ai/api/v1 |
| OpenAPI 3.1 spec | https://compeller.ai/api/v1/openapi.yaml |
| Platform capabilities (JSON) | https://compeller.ai/api/v1/capabilities |
| MCP endpoint (JSON-RPC 2.0, POST) | https://compeller.ai/api/mcp |
| Agent guide (this-site HTML) | https://compeller.ai/for-agents |
| Agent manifest (JSON) | https://compeller.ai/agents.json |
| LLM digest (text/plain) | https://compeller.ai/llms.txt |
Compel terminal events (compel.completed,
compel.failed) are delivered via HTTPS webhook to
endpoints you register. Full lifecycle is available: register, list,
show, update (url / events / active), test-delivery, rotate-secret,
delete. Deliveries are signed with HMAC-SHA256 over the raw body and
carried in X-Compeller-Signature: sha256=<hex>.
See the agent guide's webhook section or the OpenAPI spec for the full contract.
Every authenticated REST call and MCP tools/call request
sends a Compeller API token as an HTTP header. Either of these works:
Authorization: Bearer <your-api-token>
X-API-Token: <your-api-token>
Tokens are issued per Compeller user account. Missing or invalid tokens
return 401 on REST and a tool-level error on MCP.
curl -s https://compeller.ai/api/v1/openapi.yaml
curl -s https://compeller.ai/api/mcp \\
-H 'Content-Type: application/json' \\
-d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"my-agent","version":"1.0"}}}'
For end-to-end examples including webhook registration, see the agent guide's Quick start.