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

# Read job

> Read one job. Every async capability converges here, whatever produced the id — there is no per-capability polling path. A job belonging to another workspace answers 404 rather than 403, so ids cannot be used to test for existence across tenants. `status` is what a poller branches on; `phase` is the pipeline’s own stage word and is for display only. `awaiting_review` is terminal until a person acts — polling will not advance it. This deployment resolves footage edits (`video.edit`) from the shared job store and render/3D jobs from video-curriculum through its internal API. A confirmed missing job answers 404; an unavailable job store answers a retryable 503 instead. Free: reading status is never billed.



## OpenAPI

````yaml /openapi.json get /v1/jobs/{jobId}
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: 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: 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.
  - 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: 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: Channels
    description: The destinations content is made for.
  - name: Products
    description: What a campaign promotes.
paths:
  /v1/jobs/{jobId}:
    get:
      tags:
        - Jobs
      summary: Read job
      description: >-
        Read one job. Every async capability converges here, whatever produced
        the id — there is no per-capability polling path. A job belonging to
        another workspace answers 404 rather than 403, so ids cannot be used to
        test for existence across tenants. `status` is what a poller branches
        on; `phase` is the pipeline’s own stage word and is for display only.
        `awaiting_review` is terminal until a person acts — polling will not
        advance it. This deployment resolves footage edits (`video.edit`) from
        the shared job store and render/3D jobs from video-curriculum through
        its internal API. A confirmed missing job answers 404; an unavailable
        job store answers a retryable 503 instead. Free: reading status is never
        billed.
      parameters:
        - name: jobId
          in: path
          required: true
          description: The job id an asynchronous capability answered with.
          schema:
            type: string
            minLength: 1
            maxLength: 200
            description: The job id an asynchronous capability answered with.
            examples:
              - job_4k1b7d
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  job:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The job id you polled.
                        examples:
                          - job_4k1b7d
                      kind:
                        type: string
                        enum:
                          - video.render
                          - asset.animate
                          - video.edit
                        description: >-
                          What produced this job, which decides what `artifacts`
                          carries.
                      status:
                        type: string
                        enum:
                          - queued
                          - rendering
                          - awaiting_review
                          - done
                          - failed
                        description: >-
                          A closed set, safe to branch on. `done` and `failed`
                          are terminal. `awaiting_review` is reachable only for
                          footage edits and will not advance by polling — a
                          person must approve the cut list in the app.
                      phase:
                        description: >-
                          The pipeline's own stage word. Useful to show someone,
                          NOT stable across releases — branch on `status`
                          instead.
                        anyOf:
                          - type: string
                          - type: 'null'
                      artifacts:
                        type: object
                        properties:
                          video:
                            description: >-
                              THE FINISHED VIDEO — this is the download. Fetch
                              it directly: it points at the origin holding the
                              bytes, not back through this API, which is why a
                              multi-gigabyte render downloads at the origin's
                              speed rather than a gateway's. Null until `status`
                              is `done`.
                            examples:
                              - >-
                                https://api.sigmora.org/render/job_4k1b7d/download/video?exp=1785700000&sig=9f2c&ws=ws_acme
                            anyOf:
                              - type: string
                              - type: 'null'
                          thumbnail:
                            description: Poster image. Render and 3D jobs.
                            anyOf:
                              - type: string
                              - type: 'null'
                          srt:
                            description: Captions as SubRip. Render and 3D jobs.
                            anyOf:
                              - type: string
                              - type: 'null'
                          vtt:
                            description: Captions as WebVTT. Render and 3D jobs.
                            anyOf:
                              - type: string
                              - type: 'null'
                          outputKind:
                            description: >-
                              `long` or `short` on a footage-edit deliverable;
                              null on the parent shoot.
                            anyOf:
                              - type: string
                              - type: 'null'
                          parentJobId:
                            description: The shoot a footage-edit deliverable belongs to.
                            anyOf:
                              - type: string
                              - type: 'null'
                          summary:
                            description: >-
                              What the editor did: durations, layers, QC result.
                              Footage edits.
                          packaging:
                            description: >-
                              Titles, description, tags and thumbnail prompts,
                              when a channel was named.
                          review:
                            description: >-
                              The SIZE of the decision waiting on a person —
                              proposed cut count and durations, not the cuts
                              themselves. Present only while `status` is
                              `awaiting_review`.
                        additionalProperties: {}
                        description: >-
                          The outputs. Which fields are present depends on
                          `kind`; `video` is the file.
                      error:
                        description: Why it failed. Present only when `status` is `failed`.
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - id
                      - kind
                      - status
                    additionalProperties: {}
                    description: >-
                      An asynchronous unit of work and, once it is done, where
                      its output files are.
                required:
                  - success
                  - job
                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: internal_error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: 'Failure. `code` is one of: upstream_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
            - 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.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A workspace API key.

````