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

# This workspace’s API consumption, by endpoint, key and day.

> The same numbers our own dashboard reads. Defaults to the last 30 days; the window
is capped at 366 days.

Free, and readable with a key that cannot spend.



## OpenAPI

````yaml /openapi.json get /v1/usage
openapi: 3.1.0
info:
  title: Sigmora API
  version: v1
  description: >-
    Whole pipelines as single calls: describe an object and get an animated 3D
    render;

    send raw footage and get an edited cut; hand over a transcript and get it
    captioned and

    dubbed with the cue timing intact.


    **Auth.** `Authorization: Bearer sk_live_...`. A key is bound to one
    workspace, so

    requests carry no tenant id. A session caller may instead name the workspace
    with an `x-workspace-slug` header.


    **Errors.** Every failure carries a stable `code` alongside its message.
    Branch on the

    code; the message is for humans.


    **Jobs.** Long-running work returns a job id, polled at `GET
    /v1/jobs/{jobId}` whatever

    produced it.


    **Projects.** Every call files its output in a project — the container
    holding the

    script, the footage, the renders and the thread that produced them. Pass
    `projectId`

    to choose one, or omit it and get a fresh project back in the response. The
    same

    containers appear in the dashboard, because it is the same API underneath.
servers:
  - url: https://api.sigmora.org
    description: Sigmora API
security:
  - apiKey: []
paths:
  /v1/usage:
    get:
      tags:
        - meta
      summary: This workspace’s API consumption, by endpoint, key and day.
      description: >-
        The same numbers our own dashboard reads. Defaults to the last 30 days;
        the window

        is capped at 366 days.


        Free, and readable with a key that cannot spend.
      operationId: usage.get
      parameters:
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date
          description: YYYY-MM-DD. Defaults to 29 days ago.
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date
          description: YYYY-MM-DD. Defaults to today.
      responses:
        '200':
          description: Usage over the window.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - from
                  - to
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  from:
                    type: string
                    format: date
                  to:
                    type: string
                    format: date
                  creditBalance:
                    type: number
                additionalProperties: true
        '400':
          description: '`invalid_request` — malformed or over-long window.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - code
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                    description: >-
                      Human-readable. Wording 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. which field failed
                      validation.
        '401':
          description: '`unauthorized`.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - code
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                    description: >-
                      Human-readable. Wording 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. which field failed
                      validation.
        '403':
          description: '`forbidden` / `origin_not_allowed`.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - error
                  - code
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                    description: >-
                      Human-readable. Wording 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. which field failed
                      validation.
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A workspace API key (`sk_live_...`), minted from workspace settings.

````