Compeller Discovery API

openapi: 3.2.0
info:
  title: Compeller Ai Discovery API
  version: 1.0.0
  description: 'Operations tagged Discovery 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: Discovery
  description: Static capability, style, pricing, and format metadata.
paths:
  /api/v1/health:
    get:
      tags:
      - Discovery
      operationId: getApiHealth
      summary: Lightweight API health check for agents and SDKs
      description: 'Returns a small machine-readable signal that the agent-first API surface is alive.

        Operators should continue using `/status?json=true` for rich per-node health,

        database, Akka, websocket, and deployment diagnostics.'
      security: []
      responses:
        '200':
          description: API health status.
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - service
                - version
                - status_url
                - timestamp
                properties:
                  status:
                    type: string
                    enum:
                    - HEALTHY
                  service:
                    type: string
                    example: compeller-api-v1
                  version:
                    type: string
                    example: '1'
                  status_url:
                    type: string
                    example: /status?json=true
                  timestamp:
                    type: string
                    format: date-time
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/capabilities:
    get:
      tags:
      - Discovery
      operationId: getCapabilities
      summary: List platform capabilities
      security: []
      responses:
        '200':
          description: Capability descriptor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilitiesResponse'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/openapi.yaml:
    get:
      tags:
      - Discovery
      operationId: getOpenApiSpec
      summary: Fetch this OpenAPI 3.1 spec as served by the running product
      description: 'Returns the byte-for-byte contents of `docs/api/openapi.yaml` from the

        deployed build. The `/api/v1/capabilities` response advertises this

        path in its `spec_url` field. Cached for 5 minutes.'
      security: []
      responses:
        '200':
          description: OpenAPI 3.1 specification document.
          content:
            application/yaml:
              schema:
                type: string
        '500':
          $ref: '#/components/responses/Problem'
    head:
      tags:
      - Discovery
      operationId: headOpenApiSpec
      summary: Probe metadata for the OpenAPI spec without fetching its body
      description: 'Same `Content-Type` and `Cache-Control` as the GET response, but with

        no body. Intended for tools (OpenAPI Generator, Stainless, Postman)

        that probe before downloading.'
      security: []
      responses:
        '200':
          description: Headers-only acknowledgement.
        '500':
          $ref: '#/components/responses/Problem'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/styles:
    get:
      tags:
      - Discovery
      operationId: listStyles
      summary: List available visual styles
      security: []
      responses:
        '200':
          description: Style descriptor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StylesResponse'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/pricing:
    get:
      tags:
      - Discovery
      operationId: getPricing
      summary: List published subscription plans
      security: []
      responses:
        '200':
          description: Pricing descriptor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PricingResponse'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/input-formats:
    get:
      tags:
      - Discovery
      operationId: listInputFormats
      summary: Describe accepted input formats
      security: []
      responses:
        '200':
          description: Input format descriptor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InputFormatsResponse'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
  /api/v1/rendering-formats:
    get:
      tags:
      - Discovery
      operationId: listRenderingFormats
      summary: Describe supported rendering formats (aspect ratios and platform targets)
      security: []
      responses:
        '200':
          description: Rendering format descriptor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderingFormatsResponse'
    servers:
    - url: https://compeller.ai
      description: Production
    - url: https://dev.compeller.ai
      description: Development
components:
  schemas:
    PlanDescriptor:
      type: object
      required:
      - id
      - name
      - monthlyUsd
      - minutePrice
      - minuteAllowance
      - recommended
      - features
      properties:
        id:
          type: string
          description: Plan code.
          example: PRO
        name:
          type: string
          example: Pro
        monthlyUsd:
          type: number
          description: Monthly subscription amount in USD (0 for FREE and the FLEXIBLE pay-as-you-go plan).
          example: 29.0
        minutePrice:
          type: number
          description: USD charged per additional render minute beyond the monthly allowance.
          example: 0.15
        minuteAllowance:
          type: integer
          description: Render minutes included per month.
          example: 200
        recommended:
          type: boolean
          description: Whether this plan carries the "most popular" badge.
        features:
          type: array
          items:
            type: string
    CapabilitiesResponse:
      type: object
      required:
      - productName
      - version
      - capabilities
      - spec_url
      properties:
        productName:
          type: string
          example: Compeller
        version:
          type: string
          example: '1'
        capabilities:
          type: array
          items:
            type: string
          example:
          - music_video_generation
          - promo_clip_generation
          - compel_search
        spec_url:
          type: string
          description: Path at which this OpenAPI spec is served by the running product.
          example: /api/v1/openapi.yaml
    InputFormatDescriptor:
      type: object
      required:
      - type
      - formats
      properties:
        type:
          type: string
          example: audio_file
        formats:
          type: array
          items:
            type: string
    StylesResponse:
      type: object
      required:
      - productName
      - version
      - styles
      properties:
        productName:
          type: string
        version:
          type: string
        styles:
          type: array
          items:
            $ref: '#/components/schemas/StyleDescriptor'
    StyleDescriptor:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: string
          description: The exact value to pass as `style` when creating a compel.
          example: Cinematic Realistic
        name:
          type: string
          description: Human-readable style name (identical to `id` today).
          example: Cinematic Realistic
    RenderingFormatDescriptor:
      type: object
      required:
      - id
      - aspectRatio
      - targets
      properties:
        id:
          type: string
          example: vertical_9_16
        aspectRatio:
          type: string
          example: '9:16'
        targets:
          type: array
          items:
            type: string
    Problem:
      type: object
      description: RFC 7807 problem detail.
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          example: about:blank
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
    RenderingFormatsResponse:
      type: object
      required:
      - productName
      - version
      - renderingFormats
      properties:
        productName:
          type: string
        version:
          type: string
        renderingFormats:
          type: array
          items:
            $ref: '#/components/schemas/RenderingFormatDescriptor'
    InputFormatsResponse:
      type: object
      required:
      - productName
      - version
      - inputFormats
      properties:
        productName:
          type: string
        version:
          type: string
        inputFormats:
          type: array
          items:
            $ref: '#/components/schemas/InputFormatDescriptor'
    PricingResponse:
      type: object
      required:
      - productName
      - version
      - plans
      properties:
        productName:
          type: string
        version:
          type: string
        plans:
          type: array
          items:
            $ref: '#/components/schemas/PlanDescriptor'
  responses:
    Problem:
      description: RFC 7807 problem detail.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  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