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

# Run a recipe on one file

> A recipe by `recipe` — a ready-made slug, your saved recipe's id, or a shared recipe's public slug — or the `steps` written inline. Same rules as the Workbench: a step in the wrong place, an option a skill doesn't have or a paid skill on the free plan is refused before anything is charged. Each skill step is charged as it starts and refunded if it fails.



## OpenAPI

````yaml /api/openapi.reference.json post /api/v1/runs
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:
    post:
      tags:
        - Recipes
      summary: Run a recipe on one file
      description: >-
        A recipe by `recipe` — a ready-made slug, your saved recipe's id, or a
        shared recipe's public slug — or the `steps` written inline. Same rules
        as the Workbench: a step in the wrong place, an option a skill doesn't
        have or a paid skill on the free plan is refused before anything is
        charged. Each skill step is charged as it starts and refunded if it
        fails.
      operationId: runRecipe
      parameters:
        - name: dry_run
          in: query
          required: false
          description: >-
            `true` to check and price the run without running it. Same as
            `dry_run` in the body.
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/XRequestId'
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunRecipeRequest'
            examples:
              podcast-to-clips:
                summary: Podcast to clips
                description: The best moments, vertical and captioned
                value:
                  recipe: podcast-to-clips
                  url: https://example.com/clip.mp4
              tiktok-ready:
                summary: TikTok-ready video
                description: Vertical, captions burned in, cover frame picked
                value:
                  recipe: tiktok-ready
                  url: https://example.com/clip.mp4
              talking-head-edit:
                summary: Edit a talking-head video
                description: Retakes and pauses cut, hook landed, captions on
                value:
                  recipe: talking-head-edit
                  url: https://example.com/clip.mp4
              youtube-ready:
                summary: YouTube-ready video
                description: Captions on, thumbnails to test
                value:
                  recipe: youtube-ready
                  url: https://example.com/clip.mp4
              write-up-the-episode:
                summary: Write up the episode
                description: Show notes, pull quotes and a post, from one recording
                value:
                  recipe: write-up-the-episode
                  url: https://example.com/clip.mp4
              shopify-product-images:
                summary: Shopify product images
                description: Cut out, squared to one size, light WebP
                value:
                  recipe: shopify-product-images
                  url: https://example.com/photo.jpg
              amazon-listing-images:
                summary: Amazon listing images
                description: Cut out, pure white, square and zoom-ready
                value:
                  recipe: amazon-listing-images
                  url: https://example.com/photo.jpg
              product-card-from-a-photo:
                summary: Product card from a photo
                description: A clean packshot on a card with its name, price and stars
                value:
                  recipe: product-card-from-a-photo
                  url: https://example.com/photo.jpg
                  inputs:
                    name: <product name>
                    price: <price>
                    stars: '1'
                    reviews: <review count>
              product-360-spin:
                summary: Product 360 spin
                description: Cut out, orbited on white, as a looping picture
                value:
                  recipe: product-360-spin
                  url: https://example.com/photo.jpg
              bullet-time-slow-motion:
                summary: Bullet time, slowed
                description: The moment frozen, the sweep stretched out
                value:
                  recipe: bullet-time-slow-motion
                  url: https://example.com/photo.jpg
              recast-the-ad:
                summary: Recast the ad
                description: One video ad, several casts, every one captioned
                value:
                  recipe: recast-the-ad
                  url: https://example.com/clip.mp4
              translate-the-ad:
                summary: Translate the ad
                description: One video ad, re-voiced and lip-synced in a new language
                value:
                  recipe: translate-the-ad
                  url: https://example.com/clip.mp4
              ugc-ad-from-a-photo:
                summary: UGC ad from a product photo
                description: A product photo to a captioned vertical video ad
                value:
                  recipe: ugc-ad-from-a-photo
                  url: https://example.com/photo.jpg
              social-video-from-a-topic:
                summary: Social video from a topic
                description: A topic to a vertical, captioned talking video
                value:
                  recipe: social-video-from-a-topic
                  inputs:
                    topic: <topic>
                    avatar: <avatar>
              put-my-site-in-a-laptop:
                summary: Put my site in a laptop
                description: A link to your page, shown on a laptop
                value:
                  recipe: put-my-site-in-a-laptop
                  inputs:
                    link: https://example.com
              interview-to-ads:
                summary: Cut an interview into ads
                description: Long footage to several captioned short ads
                value:
                  recipe: interview-to-ads
                  url: https://example.com/clip.mp4
              interview-tidy-up:
                summary: Tidy up an interview
                description: Pauses cut, room noise gone, captions on
                value:
                  recipe: interview-tidy-up
                  url: https://example.com/clip.mp4
              tidy-up-a-scan:
                summary: Tidy up a scan
                description: Straightened, searchable, cropped and light
                value:
                  recipe: tidy-up-a-scan
                  url: https://example.com/scan.pdf
              ready-to-send-out:
                summary: Ready to send out
                description: Names and numbers gone, stamped, back as a PDF
                value:
                  recipe: ready-to-send-out
                  url: https://example.com/scan.pdf
              inline-steps:
                summary: Steps written inline
                value:
                  url: https://example.com/photo.jpg
                  steps:
                    - tool: background-remover
                    - tool: resize
                      options:
                        aspect: '1:1'
                  output:
                    format: webp
                    quality: '85'
      responses:
        '200':
          description: >-
            The run finished while the call waited — or, with `dry_run`, what it
            would cost.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Run'
                  - $ref: '#/components/schemas/DryRun'
          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'
            Idempotent-Replayed:
              $ref: '#/components/headers/Idempotent-Replayed'
        '202':
          description: The run is still going (or `wait` was false). Poll `poll_url`.
          content:
            application/json:
              schema:
                $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'
            Idempotent-Replayed:
              $ref: '#/components/headers/Idempotent-Replayed'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '413':
          $ref: '#/components/responses/TooLarge'
        '415':
          $ref: '#/components/responses/UnsupportedMedia'
        '422':
          $ref: '#/components/responses/Unprocessable'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/Unavailable'
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}$
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Retry this POST safely: the first request with a key runs and its answer
        is kept for a day; a retry with the same key and the same request gets
        that answer again, marked `Idempotent-Replayed: true`, instead of
        running twice. 1–255 printable characters — a UUID is a good one.
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    RunRecipeRequest:
      type: object
      description: >-
        One file, and the steps to run on it: a `recipe` by name, or the `steps`
        themselves. Every step is checked before anything is charged.
      properties:
        url:
          type: string
          format: uri
        upload_id:
          type: string
          format: uuid
        job_id:
          type: string
          format: uuid
        asset_id:
          type: string
          format: uuid
        recipe:
          type: string
          description: >-
            A ready-made recipe's slug, the id of one you saved on the
            Workbench, or the public slug of one somebody shared. A saved or
            shared one runs its latest version; add `@` and a number
            (`my-recipe@3`) to run an earlier one.
        recipe_id:
          type: string
          format: uuid
          description: >-
            The id of a recipe you saved. Older than `recipe`, and takes only an
            id.
        version:
          type: integer
          minimum: 1
          description: >-
            Run this version of a saved or shared recipe, rather than its
            latest. The same as `@3` on `recipe`; ready-made recipes have no
            versions.
        steps:
          type: array
          items:
            $ref: '#/components/schemas/Step'
          minItems: 1
        inputs:
          $ref: '#/components/schemas/RunInputs'
        output:
          $ref: '#/components/schemas/Output'
        wait:
          type: boolean
          default: true
        webhook_url:
          type: string
          format: uri
        save_to_vault:
          $ref: '#/components/schemas/SaveToVault'
        dry_run:
          type: boolean
          default: false
          description: >-
            Check everything and answer with the price instead of running. Also
            taken as `?dry_run=true`.
      not:
        anyOf:
          - required:
              - recipe
              - steps
          - required:
              - recipe_id
              - steps
    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
    DryRun:
      type: object
      description: >-
        What a run would cost, from `dry_run: true`: every check the run makes,
        then the price step by step instead of the run. Nothing is charged,
        queued or stored.
      properties:
        dry_run:
          const: true
        livemode:
          type: boolean
          description: False for a test key, whose runs would spend nothing.
        credits:
          type: integer
          description: What the run would charge in all.
        exact:
          type: boolean
          description: >-
            False when a step's price rests on a figure the run only learns as
            it goes — a length an earlier step hasn't made yet. Such a step has
            a `note`.
        breakdown:
          type: array
          items:
            type: object
            properties:
              step:
                type: integer
                minimum: 1
              tool:
                type: string
              credits:
                type: integer
              billed_on:
                type: string
                enum:
                  - file
                  - minute
                  - second
                  - page
                  - megapixels
                  - clip
                  - free
              runs:
                type: integer
                description: Once per file of a set above it.
              note:
                type: string
            required:
              - step
              - tool
              - credits
              - billed_on
        balance:
          type: object
          properties:
            monthly:
              type: integer
            topup:
              type: integer
            total:
              type: integer
            after:
              type: integer
        would_fail:
          type: object
          description: >-
            The refusal the live run would meet that the checks can't see — a
            short balance.
          properties:
            code:
              type: string
            message:
              type: string
      required:
        - dry_run
        - livemode
        - credits
        - exact
        - breakdown
        - balance
    Step:
      type: object
      description: >-
        One step: a skill's slug (or `convert`, `resize`, `route`), its options,
        and a prompt for the steps that take one.
      properties:
        tool:
          type: string
          examples:
            - background-remover
        options:
          type: object
          additionalProperties:
            type: string
        prompt:
          type: string
        nested:
          type: boolean
          description: >-
            Runs only on what the step above made. Only means anything under a
            generator.
      required:
        - tool
    RunInputs:
      type: object
      description: >-
        Values for the steps' `{{names}}`, like {"title": "Summer sale"}. A
        required input with no default has to be sent; a name the steps don't
        use is refused. `describe_recipe`, or GET /api/v1/recipes/{ref}, lists
        them under `inputs`. In a multipart form, send a JSON string or one
        field per input, `inputs[title]`.
      additionalProperties:
        type:
          - string
          - number
          - boolean
    Output:
      description: >-
        Save as, applied to the finished file: {"format": "webp", "quality":
        "85"}. Or a list of up to 5, one file each, all made from the last
        step's file: [{"format": "png"}, {"format": "webp"}]. In a list,
        `format` takes png, jpeg or webp. An entry that changes nothing on the
        finished file makes no file. The extra files are free.
      oneOf:
        - type: object
          additionalProperties:
            type: string
        - type: array
          minItems: 1
          maxItems: 5
          items:
            type: object
            additionalProperties:
              type: string
    SaveToVault:
      description: >-
        true to file the results in the Vault, or {"folder": "Clients/Acme"} to
        say where.
      oneOf:
        - type: boolean
        - type: object
          properties:
            folder:
              type: string
          additionalProperties: false
    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
    Idempotent-Replayed:
      description: >-
        `true` when this is the kept answer to an earlier request with the same
        `Idempotency-Key`, handed back instead of running again.
      schema:
        type: string
        enum:
          - 'true'
  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
    PaymentRequired:
      description: 'Not enough credits for this run. Codes: insufficient_credits.'
      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_credits
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#insufficient_credits
              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
    Conflict:
      description: >-
        The thing named isn't in a state to do this. Codes: job_busy,
        upload_unfinished, upload_completing, job_not_finished,
        idempotency_in_progress.
      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: job_busy
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#job_busy
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    TooLarge:
      description: >-
        The file is over the plan's ceiling, or the request body over 100 MB.
        Codes: file_too_large.
      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: file_too_large
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#file_too_large
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    UnsupportedMedia:
      description: 'The file isn''t one we take. Codes: unsupported_media.'
      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: unsupported_media
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#unsupported_media
              request_id: req_8fK2mQ0x7ZtLw3nVb1cR9dYe
    Unprocessable:
      description: >-
        Understood, but can't be done with this file. Codes: step_unavailable,
        nothing_to_save, idempotency_key_reused.
      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: step_unavailable
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#step_unavailable
              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
    Unavailable:
      description: >-
        Switched off here, or briefly unreachable. Codes: api_unavailable,
        rate_limit_unavailable, webhooks_off, idempotency_unavailable.
      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: api_unavailable
              message: What went wrong, and what to do instead.
              doc_url: https://docs.mediamonster.app/api/errors#api_unavailable
              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.