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

# Create proposal

> Create a costed, version-pinned workflow proposal.



## OpenAPI

````yaml /openapi.json post /v1/workflow/proposals
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/workflow/proposals:
    post:
      tags:
        - Workflows
      summary: Create proposal
      description: Create a costed, version-pinned workflow proposal.
      operationId: workflow.proposals.create
      parameters:
        - name: idempotency-key
          in: header
          required: true
          description: >-
            Required stable id for this logical write; reuse it after a timeout.
            Upload endpoints also require the same value in body.idempotencyKey.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Required stable id for this logical write; reuse it after a
              timeout. Upload endpoints also require the same value in
              body.idempotencyKey.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Authorized project where the proposal may run.
                snapshotId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Immutable authorized context snapshot the proposal will use.
                recipeId:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: Approved workflow recipe to pin for this proposal.
                recipeVersion:
                  description: >-
                    Immutable recipe revision to use; omit to pin the current
                    approved revision.
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 9007199254740991
                execution:
                  type: object
                  properties:
                    kind:
                      type: string
                      enum:
                        - video.render
                        - video.edit
                        - transcript.export
                        - publish.artifact
                      description: Bounded Sigmora operation this proposal may execute.
                    input:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties: {}
                      description: >-
                        Operation-specific input map; values must match the
                        chosen execution kind.
                  required:
                    - kind
                    - input
                  additionalProperties: false
                  description: Bounded operation and its validated execution input.
                usageEstimate:
                  type: object
                  properties:
                    credits:
                      type: integer
                      minimum: 0
                      maximum: 10000000
                      description: Estimated total billable credits, rounded to an integer.
                    mediaMinutes:
                      type: number
                      minimum: 0
                      maximum: 100000
                      description: Estimated media processing duration in minutes.
                    aiCredits:
                      type: number
                      minimum: 0
                      maximum: 10000000
                      description: Estimated AI-model component of the total credit use.
                  required:
                    - credits
                    - mediaMinutes
                    - aiCredits
                  additionalProperties: false
                  description: Caller-visible estimate used for credit and approval review.
                publishDestinationId:
                  description: >-
                    Approved destination id for publish work, or null when the
                    proposal does not publish.
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 200
                    - type: 'null'
                expiresAt:
                  description: Optional RFC 3339 expiry after which approval is refused.
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
              required:
                - projectId
                - snapshotId
                - recipeId
                - execution
                - usageEstimate
              additionalProperties: false
            example:
              projectId: prj_9x2a4c
              snapshotId: ctx_2e8b40
              recipeId: rcp_5c1d77
              execution:
                kind: video.render
                input:
                  story: >-
                    A mean tells you where the middle of your data sits; a
                    standard deviation tells you how far a typical point wanders
                    from it. Two classes can share a mean of 70 and still look
                    nothing alike: in one, every score lands between 65 and 75;
                    in the other, half the room scored 40 and half scored 100.
                    The standard deviation is the number that tells those
                    classes apart.
                  videoType: lesson
                  aspect: horizontal
              usageEstimate:
                credits: 300
                mediaMinutes: 6
                aiCredits: 120
              publishDestinationId: null
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  proposal:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        maxLength: 200
                    required:
                      - id
                    additionalProperties: {}
                required:
                  - success
                  - proposal
                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'
        '413':
          description: 'Failure. `code` is one of: payload_too_large.'
          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.