> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mediamonster.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Poll a recipe run

> Each step says `done`, `running`, `waiting` or `failed`; the finished files arrive under `outputs` once every step is done. Output URLs are signed for ten minutes.



## OpenAPI

````yaml /api/openapi.reference.json get /api/v1/runs/{id}
openapi: 3.1.0
info:
  title: Mediamonster API
  version: v1
  summary: Run Mediamonster's skills and recipes on your files, from code.
  description: >-
    Every skill on mediamonster.app, over HTTP: the same providers, credit
    prices and plan ceilings as the Workbench.


    Send a file as a public `url`, an earlier `job_id`, a Vault `asset_id`, or a
    multipart `file`. Calls wait up to 150 seconds for the result; `wait: false`
    answers 202 at once with a `poll_url`.


    Each skill has its own operation below, with its options as a JSON Schema
    and its price under `x-mediamonster`. Recipes — a named sequence of steps —
    run through POST /api/v1/runs.


    The same catalogue is served over MCP at /api/mcp.
  contact:
    name: Mediamonster
    url: https://docs.mediamonster.app/api/overview
servers:
  - url: https://mediamonster.app
security:
  - bearer: []
tags:
  - name: Discovery
    description: What's here, open to anyone.
  - name: Account
    description: The account and workspace behind the key.
  - name: Skills
    description: The catalogue, and the generic run.
  - name: Analysis skills
    description: Skills that hand back data about the file — tags, boxes, facts, shots.
  - name: Audio skills
    description: Skills that hand back a recording.
  - name: Document skills
    description: Skills that hand back a document.
  - name: Image skills
    description: Skills that hand back a picture.
  - name: Text skills
    description: >-
      Skills that hand back words — a transcript, subtitles, copy — and leave
      the file as it was.
  - name: Video skills
    description: Skills that hand back a video.
  - name: Recipes
    description: Named sequences of steps, run on one file.
  - name: Batches
    description: >-
      The same steps once per row of a sheet, or every combination of a few
      lists.
  - name: Convert
    description: Change a file's format or size. Free.
  - name: Jobs
    description: Poll a skill run or a conversion.
  - name: Vault
    description: Your stored files.
  - name: Galleries
    description: Client galleries.
  - name: Automations
    description: >-
      Recipes that run on the clock, once or on repeat, with nobody pressing
      Run.
  - name: Uploads
    description: Files of any size your plan takes, sent straight to storage.
  - name: Webhooks
    description: >-
      Endpoints every settled job and run is posted to, and the log of each
      attempt.
externalDocs:
  url: https://docs.mediamonster.app/api/overview
paths:
  /api/v1/runs/{id}:
    get:
      tags:
        - Recipes
      summary: Poll a recipe run
      description: >-
        Each step says `done`, `running`, `waiting` or `failed`; the finished
        files arrive under `outputs` once every step is done. Output URLs are
        signed for ten minutes.
      operationId: getRun
      parameters:
        - name: id
          in: path
          required: true
          description: The run's id.
          schema:
            type: string
            format: uuid
        - name: stream
          in: query
          required: false
          description: >-
            `true` to answer `text/event-stream`: an `event: status` each time
            it changes, then `event: done` with it settled — or as it stands
            after 150 seconds, when the stream closes. A keepalive comment every
            15 seconds holds it open.
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: The run — or, with `stream=true`, its changes as they happen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Run'
            text/event-stream:
              schema:
                type: string
                description: >-
                  Server-Sent Events: `event: status` and `event: done`, each
                  with its `data:` holding the JSON in `x-event-data`.
              x-event-data:
                $ref: '#/components/schemas/Run'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    XRequestId:
      name: X-Request-Id
      in: header
      required: false
      description: >-
        Your own id for this request — 8 to 128 letters, digits, `.`, `_`, `:`
        or `-`. Used in place of one we mint, and echoed back.
      schema:
        type: string
        pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$
  schemas:
    Run:
      type: object
      description: >-
        A recipe run: its steps in order, each with its state, and the finished
        files under `outputs` once every step is done.
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - queued
            - processing
            - complete
            - failed
        name:
          type:
            - string
            - 'null'
        recipe:
          type:
            - object
            - 'null'
          description: >-
            The recipe the steps came from, and which version of it ran. Null
            for steps sent inline.
          properties:
            ref:
              type: string
              description: The handle it was run by.
            id:
              type:
                - string
                - 'null'
              description: A saved recipe's id.
            version:
              type:
                - integer
                - 'null'
              description: The version that ran. Null for a ready-made recipe.
        steps:
          type: array
          items:
            $ref: '#/components/schemas/RunStepState'
        progress:
          type: object
          properties:
            done:
              type: integer
            total:
              type: integer
        facts:
          type: object
          description: What analysis steps worked out, by name.
        notes:
          type: array
          items:
            type: object
            properties:
              step:
                type: integer
              name:
                type: string
              text:
                type: string
        shots:
          type: array
          items: {}
        moments:
          type: array
          items: {}
        outputs:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              mime:
                type: string
              size_bytes:
                type: integer
              width:
                type:
                  - integer
                  - 'null'
              height:
                type:
                  - integer
                  - 'null'
              url:
                type: string
                format: uri
        credits_charged:
          type: integer
        error:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        poll_url:
          type: string
          examples:
            - /api/v1/runs/9a1d…
        vault:
          $ref: '#/components/schemas/VaultSave'
        livemode:
          type: boolean
          description: >-
            False for a test key's (`mm_test_…`) run, which charged nothing and
            ran nothing.
        test:
          const: true
          description: Present, and true, only on a test key's run.
      required:
        - id
        - status
        - steps
        - poll_url
    RunStepState:
      type: object
      properties:
        tool:
          type: string
        name:
          type: string
        state:
          type: string
          enum:
            - done
            - running
            - waiting
            - failed
        job_id:
          type:
            - string
            - 'null'
          format: uuid
        job_ids:
          type: array
          items:
            type: string
            format: uuid
          description: A step below one that makes a set runs once per file of it.
        files:
          type:
            - object
            - 'null'
          properties:
            done:
              type: integer
            total:
              type: integer
    VaultSave:
      type: object
      description: >-
        What `save_to_vault` filed. A run still going when the call came back
        says how to file it once it is done.
      properties:
        saved:
          type: array
          items:
            type: object
        pending:
          type: boolean
        next:
          type: string
        error:
          type: string
    Error:
      type: object
      description: >-
        Every refusal. `code` is stable and meant for programs; `message` is a
        sentence meant for people, and says what to do.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              examples:
                - missing_file
                - bad_option
                - rate_limited
            message:
              type: string
            doc_url:
              type: string
              format: uri
              description: >-
                The heading on the errors page that explains this code and its
                fix.
              examples:
                - https://docs.mediamonster.app/api/errors#bad_option
            request_id:
              type: string
              description: The same id as the `X-Request-Id` header. Quote it to support.
              examples:
                - req_8fK2mQ0x7ZtLw3nVb1cR9dYe
            param:
              type: string
              description: The one field at fault, when there is one.
              examples:
                - edges
                - url
          required:
            - code
            - message
            - doc_url
            - request_id
      required:
        - error
  headers:
    X-Request-Id:
      description: >-
        This request's id — yours, if you sent a well-formed `X-Request-Id`. The
        same as `error.request_id`. Quote it to support.
      schema:
        type: string
        examples:
          - req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    X-RateLimit-Limit:
      description: Requests a minute this key may make. Absent on a plan with no limit.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: How many of them are left this minute.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When this minute's window ends, in unix seconds.
      schema:
        type: integer
  responses:
    BadRequest:
      description: >-
        The request can't run as sent. Codes: missing_file, bad_option,
        unknown_option, bad_url, fetch_failed, bad_json, bad_file, wrong_input,
        missing_steps, bad_line, ambiguous_line, bad_recipe, bad_webhook,
        bad_upload_id, bad_idempotency_key, missing_input, bad_input,
        unknown_input, bad_inputs.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: missing_file
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#missing_file
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    Unauthorized:
      description: >-
        No key, or a key that isn't valid. Codes: missing_key, invalid_key,
        key_expired.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: missing_key
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#missing_key
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    Forbidden:
      description: >-
        The key's scopes, addresses, mode, plan or role don't allow it. Codes:
        insufficient_scope, ip_not_allowed, test_mode_unsupported,
        plan_required, plan_limit, not_allowed.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#insufficient_scope
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    NotFound:
      description: >-
        Nothing with that id or slug that this key can see. Codes:
        unknown_skill, job_not_found, run_not_found, recipe_not_found,
        recipe_version_not_found, file_not_found, rule_not_found.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unknown_skill
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#unknown_skill
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    RateLimited:
      description: >-
        Over the key's, or the account's, requests a minute. Codes:
        rate_limited, free_tool_limit.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        retry-after:
          description: Seconds to wait.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#rate_limited
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: mm_live_… or mm_test_…
      description: >-
        `Authorization: Bearer mm_live_…`. Mint a key at mediamonster.app/keys;
        every plan includes the API. A test key, `mm_test_…`, runs every check a
        live key does and spends nothing: each run finishes at once with a
        stand-in file, and says `livemode: false`. A key does only what its
        scopes allow.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.