> ## 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.

# Propose variations

> Propose a batch of variations of a proven format. Sigma's `vary_format`: a broken-down reference (the Format) x the axes to vary -> N variants in this project, under one batch quote at its ceiling (N x the per-variant price). Never starts on its own: send `approval.approval` to POST /v1/sigma/approvals. The run reserves only the variants an identical earlier output does not cover, refunds a variant that fails, and makes them in the background; follow it with GET /v1/projects/{projectId}/variations/{batchId}.



## OpenAPI

````yaml /openapi.json post /v1/projects/{projectId}/variations
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/projects/{projectId}/variations:
    post:
      tags:
        - Projects
      summary: Propose variations
      description: >-
        Propose a batch of variations of a proven format. Sigma's `vary_format`:
        a broken-down reference (the Format) x the axes to vary -> N variants in
        this project, under one batch quote at its ceiling (N x the per-variant
        price). Never starts on its own: send `approval.approval` to POST
        /v1/sigma/approvals. The run reserves only the variants an identical
        earlier output does not cover, refunds a variant that fails, and makes
        them in the background; follow it with GET
        /v1/projects/{projectId}/variations/{batchId}.
      operationId: variations.propose
      parameters:
        - name: projectId
          in: path
          required: true
          description: The project id.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            description: The project id.
        - name: idempotency-key
          in: header
          required: true
          description: >-
            Required stable id for this request; reuse it after a timeout to
            receive the same answer.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Required stable id for this request; reuse it after a timeout to
              receive the same answer.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                referenceAssetId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    The broken-down reference whose breakdown is the Format
                    (break a reference down first with a Sigma turn or the web
                    app).
                maker:
                  description: 'What each variant is: `script` (the default).'
                  type: string
                  enum:
                    - script
                count:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  description: >-
                    How many variants (1-1000); capped at the distinct
                    combinations of the axes.
                axes:
                  type: object
                  properties:
                    hooks:
                      description: Hooks to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One hook.
                    angles:
                      description: Angles to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One angle.
                    presenters:
                      description: Presenters to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One presenter.
                    voices:
                      description: Voices to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One voice.
                    languages:
                      description: Languages to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One language.
                    aspects:
                      description: Aspects to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One aspect.
                    products:
                      description: Products to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One product.
                    music:
                      description: Music directions to vary over.
                      maxItems: 50
                      type: array
                      items:
                        type: string
                        minLength: 1
                        maxLength: 300
                        description: One music direction.
                  additionalProperties: false
                  description: >-
                    The values to vary, one list per axis; give at least one.
                    Each variant takes one value from every listed axis.
                threadId:
                  description: Continue this Sigma conversation instead of starting one.
                  type: string
                  minLength: 1
                  maxLength: 200
              required:
                - referenceAssetId
                - count
                - axes
              additionalProperties: false
            example:
              referenceAssetId: cnt_8f3e2a71
              count: 6
              axes:
                hooks:
                  - You are overpaying for subscriptions you forgot about.
                  - I found $43 a month in my bank statement in two minutes.
                  - Your budget app is lying to you about one number.
                angles:
                  - first-job budgeting
                  - family household budget
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  threadId:
                    type: string
                    description: The Sigma conversation the proposal is recorded in.
                  messageId:
                    type: string
                  projectId:
                    description: >-
                      Where it runs; null for a workspace conversation until it
                      is approved.
                    type:
                      - string
                      - 'null'
                  approval:
                    type: object
                    properties:
                      tool:
                        type: string
                      summary:
                        type: string
                        description: Exactly what will change, as the web card shows it.
                      url:
                        type: string
                        description: Approve it in the web app instead.
                      credits:
                        description: The quoted price in credits.
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      unavailable:
                        description: Why it cannot run yet.
                        type: string
                      approval:
                        description: Signed reference for POST /v1/sigma/approvals.
                        type: string
                      autoApproved:
                        description: >-
                          The workspace's cost threshold already ran it; no
                          approval needed.
                        type: object
                        properties:
                          credits:
                            type: number
                          result:
                            type: object
                            properties: {}
                            additionalProperties: {}
                        required:
                          - credits
                          - result
                        additionalProperties: {}
                    required:
                      - tool
                      - summary
                      - url
                    additionalProperties: {}
                  links:
                    type: object
                    properties:
                      thread:
                        type: string
                    required:
                      - thread
                    additionalProperties: {}
                required:
                  - success
                  - threadId
                  - messageId
                  - projectId
                  - approval
                  - links
                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'
        '402':
          description: 'Failure. `code` is one of: insufficient_credits, budget_capped.'
          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'
        '409':
          description: 'Failure. `code` is one of: conflict.'
          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.