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

# Is it up

> Each component's health — the API, the database, storage, the queue and the encoders — from cheap live checks, and the overall state. 200 whatever it says, unless you pass `strict=true`: read `status`. Cached for thirty seconds. The same report is drawn at mediamonster.app/status.



## OpenAPI

````yaml /api/openapi.reference.json get /api/v1/status
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/status:
    get:
      tags:
        - Discovery
      summary: Is it up
      description: >-
        Each component's health — the API, the database, storage, the queue and
        the encoders — from cheap live checks, and the overall state. 200
        whatever it says, unless you pass `strict=true`: read `status`. Cached
        for thirty seconds. The same report is drawn at mediamonster.app/status.
      operationId: getStatus
      parameters:
        - name: strict
          in: query
          required: false
          description: >-
            `true` to answer 503 when `status` is `down`, for a monitor that
            only reads status codes. Degraded is still 200.
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: The report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusReport'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '503':
          description: 'With `strict=true` only: the report, and it says `down`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusReport'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      security: []
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:
    StatusReport:
      type: object
      description: Whether Mediamonster is up, component by component.
      properties:
        status:
          $ref: '#/components/schemas/HealthState'
        summary:
          type: string
          examples:
            - All systems operational
        checked_at:
          type: string
          format: date-time
        components:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                enum:
                  - api
                  - database
                  - storage
                  - queue
                  - render
              name:
                type: string
              status:
                $ref: '#/components/schemas/HealthState'
              note:
                type: string
                description: What was checked, or what is wrong.
              latency_ms:
                type:
                  - integer
                  - 'null'
                description: How long the check took.
            required:
              - id
              - name
              - status
              - note
              - latency_ms
        uptime_targets:
          type: array
          description: The monthly uptime aimed for on each plan.
          items:
            type: object
            properties:
              plan:
                type: string
              target:
                type: string
            required:
              - plan
              - target
      required:
        - status
        - summary
        - checked_at
        - components
        - uptime_targets
    HealthState:
      type: string
      enum:
        - operational
        - degraded
        - down
        - unknown
      description: >-
        `unknown` means the check couldn't tell, and doesn't move the overall
        state. The overall state is `down` only when the API, database or
        storage is.
  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
  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.