> ## 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 video analysis

> Read your saved video analysis without another charge.



## OpenAPI

````yaml /openapi.json get /v1/video/analyses/{analysisId}
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/analyses/{analysisId}:
    get:
      tags:
        - Video
      summary: Read video analysis
      description: Read your saved video analysis without another charge.
      operationId: getVideoAnalysesByAnalysisId
      parameters:
        - name: analysisId
          in: path
          required: true
          description: Saved analysis id returned by POST /v1/video/analyze.
          schema:
            type: string
            maxLength: 100
            description: Saved analysis id returned by POST /v1/video/analyze.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  analysis:
                    type: object
                    properties:
                      id:
                        type: string
                      videoUrl:
                        type: string
                        format: uri
                      analyzedAt:
                        type: string
                      durationSeconds:
                        type: number
                        exclusiveMinimum: 0
                      hook:
                        type: object
                        properties:
                          text:
                            type:
                              - string
                              - 'null'
                          type:
                            type: string
                            enum:
                              - question
                              - tutorial_promise
                              - pov_setup
                              - statistic
                              - statement
                              - unknown
                          visual:
                            type:
                              - string
                              - 'null'
                          visualType:
                            type: string
                            enum:
                              - close_up
                              - talking_head
                              - text_overlay
                              - action
                              - unknown
                          evidence:
                            type: array
                            items:
                              type: object
                              properties:
                                startSeconds:
                                  type: number
                                  minimum: 0
                                endSeconds:
                                  type: number
                                  minimum: 0
                                text:
                                  type: string
                                source:
                                  type: string
                                  enum:
                                    - speech
                                    - visual
                              required:
                                - startSeconds
                                - endSeconds
                                - text
                                - source
                        required:
                          - text
                          - type
                          - visual
                          - visualType
                          - evidence
                      scenes:
                        type: array
                        items:
                          type: object
                          properties:
                            startSeconds:
                              type: number
                              minimum: 0
                            endSeconds:
                              type: number
                              minimum: 0
                            text:
                              type: string
                            source:
                              type: string
                              enum:
                                - speech
                                - visual
                          required:
                            - startSeconds
                            - endSeconds
                            - text
                            - source
                      transcript:
                        type: array
                        items:
                          type: object
                          properties:
                            startSeconds:
                              type: number
                              minimum: 0
                            endSeconds:
                              type: number
                              minimum: 0
                            text:
                              type: string
                            source:
                              type: string
                              enum:
                                - speech
                                - visual
                          required:
                            - startSeconds
                            - endSeconds
                            - text
                            - source
                      pacing:
                        type: object
                        properties:
                          observedSceneCount:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          medianSceneSeconds:
                            type:
                              - number
                              - 'null'
                        required:
                          - observedSceneCount
                          - medianSceneSeconds
                      ctas:
                        type: array
                        items:
                          type: object
                          properties:
                            startSeconds:
                              type: number
                              minimum: 0
                            endSeconds:
                              type: number
                              minimum: 0
                            text:
                              type: string
                            source:
                              type: string
                              enum:
                                - speech
                                - visual
                          required:
                            - startSeconds
                            - endSeconds
                            - text
                            - source
                      lowConfidenceFields:
                        type: array
                        items:
                          type: string
                      method:
                        type: string
                        const: video-frames-and-acoustic-transcript
                    required:
                      - id
                      - videoUrl
                      - analyzedAt
                      - durationSeconds
                      - hook
                      - scenes
                      - transcript
                      - pacing
                      - ctas
                      - lowConfidenceFields
                      - method
                required:
                  - success
                  - analysis
                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.