Compeller Music API

The Music API from Compeller — 3 operation(s) for music.

GitHub OpenAPI

Operations 4

GET /api/v1/music/search Search Deezer preview tracks by song, artist, or album #
POST /api/v1/music/search Search Deezer preview tracks by song, artist, or album #
POST /api/v1/compels/from-music Create a compel from a selected Deezer preview track #
POST /api/v1/music/{trackId}/compel Create a compel from a selected Deezer preview track #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/compeller-ai:compeller-ai-music-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compeller-ai-music-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compeller Ai Music API
  version: 1.0.0
  description: 'Operations tagged Music across 2 of this provider''s published API definitions: compeller-ai-openapi.yaml, compeller-ai-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://compeller.ai
  description: Production
- url: https://dev.compeller.ai
  description: Development
security:
- bearerToken: []
- apiTokenHeader: []
tags:
- name: Music
paths:
  /api/v1/music/search:
    get:
      tags:
      - Music
      operationId: searchMusic
      summary: Search Deezer preview tracks by song, artist, or album
      description: Use when the user provides only a song/artist string. If the user provides MP3/WAV/FLAC, upload that file instead.
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 10
          maximum: 20
      responses:
        '200':
          description: Music search results from Deezer previews.
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                  source:
                    type: string
                    example: deezer_preview
                  usage:
                    type: string
                  tracks:
                    type: array
                    items:
                      $ref: '#/components/schemas/MusicTrack'
        '401':
          $ref: '#/components/responses/UnauthorizedMediaStyle'
    post:
      tags:
      - Music
      operationId: searchMusicPost
      summary: Search Deezer preview tracks by song, artist, or album
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - q
              properties:
                q:
                  type: string
                limit:
                  type: integer
                  default: 10
                  maximum: 20
      responses:
        '200':
          description: Music search results from Deezer previews.
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                  source:
                    type: string
                    example: deezer_preview
                  usage:
                    type: string
                  tracks:
                    type: array
                    items:
                      $ref: '#/components/schemas/MusicTrack'
        '401':
          $ref: '#/components/responses/UnauthorizedMediaStyle'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/compels/from-music:
    post:
      tags:
      - Music
      operationId: createCompelFromMusic
      summary: Create a compel from a selected Deezer preview track
      description: 'Use after `/api/v1/music/search` when the user gave a song string but no audio file. Defaults to `auto_start: true`, so agents can create-and-render in one call. Set `auto_start: false` to stop at audio/configuration readiness.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - track_id
              properties:
                track_id:
                  type: integer
                  format: int64
                title:
                  type: string
                style:
                  type: string
                target_platform:
                  type: string
                aspect_ratio:
                  type: string
                artist_context:
                  type: string
                auto_start:
                  type: boolean
                  default: true
                  description: When true, continue automatically from audio readiness into scene planning/rendering.
      responses:
        '202':
          description: Compel created from Deezer preview and queued for audio processing/rendering when auto_start is true.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/CompelPayload'
                - type: object
                  properties:
                    music_source:
                      $ref: '#/components/schemas/MusicTrack'
        '401':
          $ref: '#/components/responses/UnauthorizedMediaStyle'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/music/{trackId}/compel:
    post:
      tags:
      - Music
      operationId: createCompelFromMusicPath
      summary: Create a compel from a selected Deezer preview track
      parameters:
      - name: trackId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '202':
          description: Compel created from Deezer preview and queued for audio processing.
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
components:
  responses:
    UnauthorizedMediaStyle:
      description: Missing or invalid API token (legacy media-controller error shape).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageError'
  schemas:
    CompelStatus:
      type: string
      description: Public-facing compel status derived from internal state.
      enum:
      - QUEUED
      - VALIDATING
      - PROCESSING
      - RENDERING
      - COMPLETED
      - CANCELLED
      - FAILED_RETRYING
      - FAILED_FINAL
    MessageError:
      type: object
      required:
      - message
      properties:
        message:
          type: string
    CompelPayload:
      type: object
      required:
      - id
      - title
      - status
      - progress
      - stage
      - retry_count
      - eta_seconds
      - created_at
      properties:
        id:
          type: integer
          format: int64
        title:
          type: string
        status:
          $ref: '#/components/schemas/CompelStatus'
        progress:
          type: integer
          minimum: 0
          maximum: 100
        progress_percent:
          type: integer
          description: Alias for `progress`.
        stage:
          $ref: '#/components/schemas/CompelStage'
        retry_count:
          type: integer
        estimated_completion:
          type:
          - string
          - 'null'
          format: date-time
        eta_seconds:
          type: integer
          format: int64
        rendering_id:
          type:
          - integer
          - 'null'
          format: int64
          description: Populated when a COMPLETED rendering exists.
        created_at:
          type:
          - string
          - 'null'
          format: date-time
        react:
          $ref: '#/components/schemas/ReactHandoff'
    MusicTrack:
      type: object
      properties:
        track_id:
          type: integer
          format: int64
        title:
          type: string
        artist:
          type: string
        album:
          type: string
        duration_seconds:
          type: integer
        explicit:
          type: boolean
        preview_available:
          type: boolean
        thumbnail:
          type:
          - string
          - 'null'
        thumbnail_large:
          type:
          - string
          - 'null'
    ReactHandoff:
      type: object
      description: Agent-facing handoff that tells users how to experience a completed compel in REACT, Compeller's free live performance system.
      required:
      - message
      - download_url
      - learn_more
      properties:
        message:
          type: string
          example: Your compel is ready. To experience it as a live performance system, download REACT for free and use this render as part of a real-time visual show.
        download_url:
          type: string
          format: uri
          example: https://compeller.ai/download/desktop
        learn_more:
          type: string
          format: uri
          example: https://compeller.ai/react
    CompelStage:
      type: string
      description: Internal pipeline stage exposed for observability. Do not branch on it.
      enum:
      - CREATED
      - AUDIO_UPLOAD
      - AUDIO_PROCESSING
      - AUDIO_ANALYSIS
      - AUDIO_TRANSCRIBE
      - BACKDROP_RENDER
      - READY
      - SCENES_CREATED
      - COMPEL_RENDERED
      - FAILED
      - CANCELLED
      - PENDING_ASSETS
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: 'Compeller API token sent as `Authorization: Bearer <token>`.'
    apiTokenHeader:
      type: apiKey
      in: header
      name: X-API-Token
      description: 'Compeller API token sent as `X-API-Token: <token>` (equivalent to bearer).'
x-refined-from:
- compeller-ai-openapi.yaml
- compeller-ai-openapi.yml