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

# Convert or resize one file

> Free — only skills cost credits. Pictures are written as png, jpeg or webp (webp by default), video as mp4 or webm (mp4 by default); anything else is refused rather than quietly swapped.



## OpenAPI

````yaml /api/openapi.reference.json post /api/v1/convert
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/convert:
    post:
      tags:
        - Convert
      summary: Convert or resize one file
      description: >-
        Free — only skills cost credits. Pictures are written as png, jpeg or
        webp (webp by default), video as mp4 or webm (mp4 by default); anything
        else is refused rather than quietly swapped.
      operationId: convertMedia
      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:
              type: object
              description: A file, and what to write it as.
              properties:
                url:
                  type: string
                  format: uri
                  description: A public http(s) link to the file.
                upload_id:
                  type: string
                  format: uuid
                  description: A finished direct upload.
                job_id:
                  type: string
                  format: uuid
                  description: An earlier job's id, to reuse its source file.
                asset_id:
                  type: string
                  format: uuid
                  description: A Vault file's id.
                format:
                  type: string
                  enum:
                    - png
                    - jpeg
                    - jpg
                    - webp
                    - mp4
                    - webm
                quality:
                  type: integer
                  minimum: 20
                  maximum: 100
                  default: 85
                width:
                  type: integer
                  minimum: 16
                height:
                  type: integer
                  minimum: 16
                aspect:
                  type: string
                  default: original
                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`.
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              additionalProperties:
                type: string
      responses:
        '200':
          description: >-
            The conversion finished while the call waited — or, with `dry_run`,
            what it would cost.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Job'
                  - $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 conversion is still going (or `wait` was false). Poll
            `poll_url`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
          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:
    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
    Job:
      type: object
      description: >-
        One run of one skill, or one conversion. While `status` is `queued` or
        `processing`, poll `poll_url`.
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - queued
            - processing
            - complete
            - failed
        skill:
          type:
            - string
            - 'null'
          description: The skill's slug; null for a conversion.
        format:
          type:
            - string
            - 'null'
          description: What a conversion wrote; null for a skill.
        source:
          type: object
          properties:
            name:
              type: string
            mime:
              type: string
            size_bytes:
              type: integer
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/JobOutput'
        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/jobs/3f0c…
        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
        - outputs
        - 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
    JobOutput:
      type: object
      description: >-
        One thing a job made. A file has a signed `url` that expires in ten
        minutes — read the job again rather than retry an old link. Words come
        back in `text`, and data (tags, boxes, facts) in `data`, with `url`
        null.
      properties:
        name:
          type: string
        kind:
          type: string
        mime:
          type: string
        size_bytes:
          type: integer
        width:
          type:
            - integer
            - 'null'
        height:
          type:
            - integer
            - 'null'
        url:
          type:
            - string
            - 'null'
          format: uri
        text:
          type:
            - string
            - 'null'
        data: {}
    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.