> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sigmora.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Discover video options

> Discover every supported video selector and live renderer profile. Free, tenant-scoped discovery for POST /v1/video/render, POST /v1/video/shorts, and the 3D routes. Returns domains, quality and renderer vocabularies, live renderer readiness, TTS providers/models/voices, course workflows/capabilities/templates, chess formats/audiences/duration policy, derivative platforms, artifact kinds, and asset-animation flows. Read this instead of hard-coding deployment choices.



## OpenAPI

````yaml /openapi.json get /v1/video/options
openapi: 3.1.0
info:
  title: Sigmora API
  version: 1.0.0
  description: >-
    The priced, versioned public API. Every call authenticates with a workspace
    API key (`Authorization: Bearer sk_live_…`), names the project it files its
    output under, and reports what it cost. `GET /v1/capabilities` answers what
    this deployment can serve right now and at what price; anything it reports
    as unavailable answers 503 `capability_unavailable` rather than 404.
servers:
  - url: https://api.sigmora.org
security:
  - bearerAuth: []
tags:
  - name: Meta
    description: What this deployment serves, what it costs, and what you have spent.
  - name: Projects
    description: The container every capability files its output under.
  - name: Sessions
    description: Durable bindings between an external harness session and one project.
  - name: Assets
    description: 'Project media: direct-to-storage uploads, imports, ingest and transcripts.'
  - name: Jobs
    description: Where every asynchronous capability is collected, whatever produced it.
  - name: Text
    description: Scripts, research, articles, translation and question sets.
  - name: Video
    description: Narrated renders, footage edits, shorts and moment selection.
  - name: UGC
    description: >-
      Creator-led vertical videos: AI creators, their faces and voices, frames
      and clips.
  - name: Editing
    description: >-
      Sigma, the editor: conversational turns, granular transcript edits,
      approvals.
  - name: 3D
    description: Animated 3D renders from a description or a photograph.
  - name: Image
    description: Thumbnails, sized for the platform they are posted to.
  - name: Audio
    description: Generated music and audio engineering in Audiotool projects.
  - name: Publishing
    description: Connected destinations and queued posts.
  - name: Webhooks
    description: Signed, at-least-once delivery of job and publishing events.
  - name: Workflows
    description: Context snapshots, versioned recipes, costed proposals and their runs.
  - name: Agents
    description: Describe an outcome and let a bounded plan of capabilities run.
  - name: Research
    description: >-
      Observed hooks, creator outliers and production briefs from saved
      analyses.
  - name: Themes
    description: The canonical content taxonomy, and the niche profiles built on it.
  - name: Signals
    description: Evidence-backed trends and scored viral content.
  - name: Discovery
    description: Compiled watch plans, their runs, and source freshness.
  - name: Watchlist
    description: 'Accounts you watch: their usual reach and the posts that beat it.'
  - name: Performance
    description: Your own channels' videos against their usual, and fixes to live videos.
  - name: Autopilot
    description: The durable trend-to-distribution workflow and its checkpoints.
  - name: Campaigns
    description: Distribution records shared by the API, the dashboard and autopilot.
  - name: Brands
    description: >-
      Cross-platform identities with their own voice, rules and publishing
      commitments.
  - name: Products
    description: What a campaign promotes.
paths:
  /v1/video/options:
    get:
      tags:
        - Video
      summary: Discover video options
      description: >-
        Discover every supported video selector and live renderer profile. Free,
        tenant-scoped discovery for POST /v1/video/render, POST
        /v1/video/shorts, and the 3D routes. Returns domains, quality and
        renderer vocabularies, live renderer readiness, TTS
        providers/models/voices, course workflows/capabilities/templates, chess
        formats/audiences/duration policy, derivative platforms, artifact kinds,
        and asset-animation flows. Read this instead of hard-coding deployment
        choices.
      operationId: getVideoOptions
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  options:
                    type: object
                    properties:
                      schemaRevision:
                        type: string
                      schemaDigest:
                        type: string
                        pattern: ^[a-f0-9]{64}$
                      domains:
                        type: array
                        items:
                          type: object
                          properties:
                            domain:
                              type: string
                              enum:
                                - algorithms
                                - science
                                - course
                                - howto
                                - stories
                                - chess
                                - ugc
                            idDriven:
                              type: boolean
                          required:
                            - domain
                            - idDriven
                      qualities:
                        type: array
                        items:
                          type: string
                          enum:
                            - l
                            - m
                            - h
                            - k
                      renderers:
                        type: array
                        items:
                          type: string
                          enum:
                            - motif
                            - images
                            - blender
                      rendererProfiles:
                        type: array
                        items:
                          type: object
                          properties:
                            renderer:
                              type: string
                            implemented:
                              type: boolean
                            configured:
                              type: boolean
                            productionCapability:
                              type: string
                            executionBackend:
                              type: string
                            productionMode:
                              type: string
                            availableProductionModes:
                              type: array
                              items:
                                type: string
                            cinematicConfigured:
                              type: boolean
                            visionRefineConfigured:
                              type: boolean
                            assetPack:
                              type: object
                              properties:
                                id:
                                  type: string
                                version:
                                  type: string
                            reason:
                              type:
                                - string
                                - 'null'
                          required:
                            - renderer
                            - implemented
                            - configured
                      ttsProviders:
                        type: array
                        items:
                          type: string
                          enum:
                            - speechify
                            - elevenlabs
                            - deepgram
                            - gemini
                      ttsModels:
                        type: array
                        items:
                          type: object
                          properties:
                            provider:
                              type: string
                              enum:
                                - speechify
                                - elevenlabs
                                - deepgram
                                - gemini
                            defaultModel:
                              type: string
                            choices:
                              anyOf:
                                - type: array
                                  items:
                                    type: string
                                - type: 'null'
                            pattern:
                              type:
                                - string
                                - 'null'
                            automaticFallback:
                              type: boolean
                              const: false
                          required:
                            - provider
                            - defaultModel
                            - choices
                            - pattern
                            - automaticFallback
                      voices:
                        type: array
                        items:
                          type: object
                          properties:
                            provider:
                              type: string
                              enum:
                                - speechify
                                - elevenlabs
                                - deepgram
                                - gemini
                            defaultVoice:
                              type: string
                            defaultModel:
                              type:
                                - string
                                - 'null'
                            choices:
                              anyOf:
                                - type: array
                                  items:
                                    type: string
                                - type: 'null'
                            cloning:
                              type: object
                              properties:
                                supported:
                                  type: boolean
                                selfServe:
                                  type: boolean
                                note:
                                  type: string
                              required:
                                - supported
                                - selfServe
                          required:
                            - provider
                            - defaultVoice
                            - defaultModel
                            - choices
                            - cloning
                      artifactKinds:
                        type: array
                        items:
                          type: string
                      durablePromotion:
                        type: object
                        properties:
                          requiredForFinal:
                            type: boolean
                          configured:
                            type: boolean
                          backend:
                            type:
                              - string
                              - 'null'
                        required:
                          - requiredForFinal
                          - configured
                      coursePublishing:
                        type: object
                        properties:
                          schemaVersion:
                            type: string
                          workflows:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                version:
                                  type: string
                                title:
                                  type: string
                                description:
                                  type: string
                                capabilities:
                                  type: array
                                  items:
                                    type: string
                                visualKinds:
                                  type: array
                                  items:
                                    type: string
                                qualityRules:
                                  type: array
                                  items:
                                    type: string
                                maxStaticSeconds:
                                  type: number
                                  exclusiveMinimum: 0
                              required:
                                - id
                                - version
                                - title
                                - description
                                - capabilities
                                - visualKinds
                                - qualityRules
                                - maxStaticSeconds
                          capabilities:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                title:
                                  type: string
                                description:
                                  type: string
                                visualKinds:
                                  type: array
                                  items:
                                    type: string
                                qualityRules:
                                  type: array
                                  items:
                                    type: string
                                maxStaticSeconds:
                                  type: number
                                  exclusiveMinimum: 0
                              required:
                                - id
                                - title
                                - description
                                - visualKinds
                                - qualityRules
                                - maxStaticSeconds
                        required:
                          - schemaVersion
                          - workflows
                          - capabilities
                      courseVideoProduction:
                        type: object
                        properties:
                          schemaVersion:
                            type: string
                          classifierVersion:
                            type: string
                          archetypes:
                            type: array
                            items:
                              type: string
                              enum:
                                - faceless-explainer
                                - finance-explainer
                                - lesson-deep-dive
                                - tutorial-how-to
                                - presentation
                                - short-quick-tip
                                - market-recap
                          templates:
                            type: array
                            items:
                              type: object
                              properties:
                                templateId:
                                  type: string
                                  enum:
                                    - editorial-signal
                                    - night-interface
                                    - evidence-ledger
                                    - footage-journal
                                    - presenter-focus
                                    - founder-editorial
                                    - kinetic-impact
                                revisionId:
                                  type: string
                                revisionSha256:
                                  type: string
                                  pattern: ^[a-f0-9]{64}$
                                rendererTheme:
                                  type: string
                              required:
                                - templateId
                                - revisionId
                                - revisionSha256
                                - rendererTheme
                          durationPolicies:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                          rendererStrategy:
                            type: string
                          compositionStrategy:
                            type: string
                        required:
                          - schemaVersion
                          - classifierVersion
                          - archetypes
                          - templates
                          - durationPolicies
                          - rendererStrategy
                          - compositionStrategy
                      chessVideoProduction:
                        type: object
                        properties:
                          schemaVersion:
                            type: string
                          classifierVersion:
                            type: string
                          archetype:
                            type: string
                          defaultFormat:
                            type: string
                            enum:
                              - full-game-analysis
                              - tactical-breakdown
                              - opening-story
                              - endgame-lesson
                          defaultAudience:
                            type: string
                            enum:
                              - beginner
                              - intermediate
                              - advanced
                          defaultTargetMinutes:
                            type: number
                            exclusiveMinimum: 0
                          targetMinutes:
                            type: object
                            properties:
                              min:
                                type: number
                                exclusiveMinimum: 0
                              max:
                                type: number
                                exclusiveMinimum: 0
                              recommendedMin:
                                type: number
                                exclusiveMinimum: 0
                              recommendedMax:
                                type: number
                                exclusiveMinimum: 0
                            required:
                              - min
                              - max
                              - recommendedMin
                              - recommendedMax
                          requireVisionAuditByDefault:
                            type: boolean
                          visionAuditConfigured:
                            type: boolean
                          formats:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - full-game-analysis
                                    - tactical-breakdown
                                    - opening-story
                                    - endgame-lesson
                                label:
                                  type: string
                                promptAim:
                                  type: string
                              required:
                                - id
                                - label
                                - promptAim
                          audiences:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  enum:
                                    - beginner
                                    - intermediate
                                    - advanced
                                label:
                                  type: string
                                ratingAnchor:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                promptAim:
                                  type: string
                              required:
                                - id
                                - label
                                - ratingAnchor
                                - promptAim
                          template:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties: {}
                        required:
                          - schemaVersion
                          - classifierVersion
                          - archetype
                          - defaultFormat
                          - defaultAudience
                          - defaultTargetMinutes
                          - targetMinutes
                          - requireVisionAuditByDefault
                          - visionAuditConfigured
                          - formats
                          - audiences
                          - template
                      storyMaxChars:
                        anyOf:
                          - type: integer
                            exclusiveMinimum: 0
                            maximum: 9007199254740991
                          - type: 'null'
                      assetFlows:
                        type: array
                        items:
                          type: object
                          properties:
                            flow:
                              type: string
                            implemented:
                              type: boolean
                            configured:
                              type: boolean
                            gpu:
                              type: boolean
                            input:
                              type: string
                            accepts:
                              type: string
                            requires:
                              type: string
                            reason:
                              type:
                                - string
                                - 'null'
                          required:
                            - flow
                            - implemented
                            - configured
                      assetPresets:
                        type: array
                        items:
                          type: string
                      derivativePlatforms:
                        type: array
                        items:
                          type: string
                          enum:
                            - tiktok
                            - reels
                            - shorts
                            - twitter
                    required:
                      - domains
                      - qualities
                      - renderers
                      - rendererProfiles
                      - ttsProviders
                      - ttsModels
                      - voices
                      - artifactKinds
                      - durablePromotion
                      - coursePublishing
                      - courseVideoProduction
                      - chessVideoProduction
                      - storyMaxChars
                      - assetFlows
                      - assetPresets
                      - derivativePlatforms
                required:
                  - success
                  - options
                additionalProperties: {}
        '400':
          description: 'Failure. `code` is one of: invalid_request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Failure. `code` is one of: unauthorized.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Failure. `code` is one of: forbidden, origin_not_allowed.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: 'Failure. `code` is one of: not_found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Failure. `code` is one of: rate_limited.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failure. `code` is one of: upstream_error, internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Failure. `code` is one of: capability_unavailable,
            upstream_unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: >-
            Human-readable. Copy may change between releases — do not match on
            it.
        code:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - forbidden
            - origin_not_allowed
            - not_found
            - conflict
            - payload_too_large
            - insufficient_credits
            - budget_capped
            - content_not_cleared
            - rate_limited
            - capability_unavailable
            - upstream_unavailable
            - upstream_error
            - internal_error
          description: Stable machine-readable cause. Branch on this.
        details:
          description: Optional structured context, e.g. the credits shortfall.
        requestId:
          type: string
          description: >-
            Identifies this request in our logs. Include it when you contact
            support.
        timestamp:
          type: string
          format: date-time
          description: When the failure was produced.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.