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

# List runs

> Cursor-paginated list of the workspace's runs, newest first. Optional `status` filter.



## OpenAPI

````yaml https://monid.ai/openapi.json get /v1/runs
openapi: 3.1.0
info:
  title: Monid API
  version: 0.1.0
  description: >-
    Agentic payment platform for data — agents discover and buy data on demand.
    Authenticated `/v1/*` routes accept a Monid API key or Clerk JWT as a Bearer
    token. All errors return `{ code, message }`. List endpoints use cursor
    pagination; consult each operation schema for its last-page cursor encoding.
servers:
  - url: https://api.monid.ai
    description: Production
  - url: https://monid.ai
    description: Public registry alias (public/v1 only)
security: []
paths:
  /v1/runs:
    get:
      tags:
        - Runs
      summary: List runs
      description: >-
        Cursor-paginated list of the workspace's runs, newest first. Optional
        `status` filter.
      parameters:
        - schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 100
            description: Max items per page (server-side cap applies).
            example: 20
          required: false
          description: Max items per page (server-side cap applies).
          name: limit
          in: query
        - schema:
            type: string
            description: Cursor returned by the previous page.
          required: false
          description: Cursor returned by the previous page.
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - READY
              - RUNNING
              - STOPPING
              - COMPLETED
              - FAILED
              - BLOCKED
              - STOPPED
              - TIMED_OUT
            description: >-
              Filter runs by lifecycle status. Uppercase enum value only (e.g.
              COMPLETED, never completed).
          required: false
          description: >-
            Filter runs by lifecycle status. Uppercase enum value only (e.g.
            COMPLETED, never completed).
          name: status
          in: query
        - $ref: '#/components/parameters/AgentModelHeader'
        - $ref: '#/components/parameters/AgentHarnessHeader'
        - $ref: '#/components/parameters/AgentSessionIdHeader'
      responses:
        '200':
          description: Runs page
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/RunListItem'
                  cursor:
                    type: string
                    description: Opaque cursor for the next page. Absent on the last page.
                required:
                  - items
        '400':
          description: Bad request — input failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized — missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — caller has no workspace or no access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limited (errorCode `RATE_LIMITED`, message `Rate limited. Retry
            after Ns.`) — the `Retry-After` header carries whole seconds until
            the caller may retry; `RateLimit-Limit/-Remaining/-Reset` describe
            the binding limit as numbers only (also sent on allowed responses
            that matched a rule; responses that matched no rule, or an
            `unlimited` exemption, carry none of them). Applies to every
            authenticated `/v1` route (per API key / user / workspace); POST
            /v1/run additionally enforces per-provider/endpoint run limits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - Bearer:
            - runs:list
components:
  parameters:
    AgentModelHeader:
      name: X-Monid-Agent-Model
      in: header
      required: false
      description: >-
        Model driving the calling agent. Optional; a value that is empty, longer
        than 256 characters or not printable ASCII is ignored (never an error).
      schema:
        type: string
        maxLength: 256
      example: claude-opus-5-5
    AgentHarnessHeader:
      name: X-Monid-Agent-Harness
      in: header
      required: false
      description: >-
        Agent harness or client making the call (e.g. a coding agent, an agent
        framework). Optional; a value that is empty, longer than 256 characters
        or not printable ASCII is ignored (never an error).
      schema:
        type: string
        maxLength: 256
      example: claude-code
    AgentSessionIdHeader:
      name: X-Monid-Agent-Session-Id
      in: header
      required: false
      description: >-
        Caller-side session identifier, so the calls of one agent session
        (discover → inspect → run → polling) can be correlated. Optional; a
        value that is empty, longer than 256 characters or not printable ASCII
        is ignored (never an error).
      schema:
        type: string
        maxLength: 256
      example: 01JABCDEF0123456789XYZ
  schemas:
    RunListItem:
      type: object
      properties:
        runId:
          type: string
          description: Run identifier (ULID).
          example: 01JGXYZABCDEFGHJKMNPQRSTVW
        caller:
          type: string
          description: >-
            The CREDENTIAL that made the call, as an actor id:
            `API_KEY#<fingerprint>` (an API key), `X402#<address>` (a wallet),
            `RESOURCE#<id>` (a webhook-initiated run), `USER#<userId>` (a
            session). The user behind it is `owner`.
          example: API_KEY#a1b2c3d4
        owner:
          type: string
          description: >-
            User id the run belongs to (billed / attributed). Absent for wallet
            (x402) and resource-initiated runs, which have no user.
          example: user_2abc
        provider:
          type: string
        providerName:
          type: string
        endpoint:
          type: string
        status:
          type: string
          enum:
            - READY
            - RUNNING
            - STOPPING
            - COMPLETED
            - FAILED
            - BLOCKED
            - STOPPED
            - TIMED_OUT
          description: >-
            Run lifecycle status. Always one of the UPPERCASE enum values (e.g.
            COMPLETED, never completed) — compare case-sensitively. COMPLETED
            means the provider responded (any HTTP status); FAILED means an
            infrastructure failure.
        stoppable:
          type: boolean
        providerResponse:
          $ref: '#/components/schemas/ProviderResponse'
        price:
          $ref: '#/components/schemas/Price'
        cost:
          $ref: '#/components/schemas/Cost'
        resultCount:
          type: number
          minimum: 0
        billedUnits:
          type: number
          minimum: 0
        createdAt:
          type: string
          format: date-time
        startedAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
      required:
        - runId
        - caller
        - provider
        - endpoint
        - status
        - price
        - createdAt
    Error:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code, duplicated in the body.
          example: 400
        message:
          type: string
          description: Human-readable error description.
          example: Bad Request
        hints:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - command
                      - discover
                      - inspect
                      - run
                      - getRun
                      - stop
                      - releaseResource
                      - topup
                  command:
                    type: string
                  query:
                    type: string
                  provider:
                    type: string
                  endpoint:
                    type: string
                  runId:
                    type: string
                  resourceId:
                    type: string
                  stripe:
                    type: string
                  dashboard:
                    type: string
                  docs:
                    type: string
                  comment:
                    type: string
                required:
                  - kind
          description: >-
            Optional next actions, rendered for the calling client like
            run-response hints (e.g. the paid TinyFish version on a free-quota
            429 — spending permission required).
        errorCode:
          type: string
          enum:
            - RATE_LIMITED
            - X402_WORKSPACE_RESOURCES
            - X402_WORKSPACE_ONLY
            - X402_ACCRUING_COST
            - X402_EXCEEDS_SETTLEMENT_WINDOW
            - X402_VALIDITY_WINDOW_TOO_SHORT
            - X402_UNBOUNDED_PRICE
            - X402_PROMOTION
            - INSUFFICIENT_SCOPE
            - WALLET_INSUFFICIENT_FUNDS
            - IDENTITY_PROVIDER_UNKNOWN
            - IDENTITY_LINK_REQUIRES_SESSION
            - IDENTITY_LINK_STATE_INVALID
            - IDENTITY_VERIFICATION_FAILED
            - IDENTITY_PROVIDER_UNAVAILABLE
            - IDENTITY_ALREADY_LINKED
            - IDENTITY_USER_ALREADY_LINKED
            - IDENTITY_LINK_RATE_LIMITED
            - IDENTITY_REQUIRED
            - PROMO_IDENTITY_REDEEMED
            - PROMO_REDEEM_REQUIRES_SESSION
            - PROMO_CODE_REDEEMED_BY_WORKSPACE
            - PROMO_CODE_REDEEMED_BY_USER
          description: >-
            OPTIONAL machine-readable discriminant from the documented
            `ApiErrorCode` registry. Absent on legacy errors; clients MUST treat
            unknown values as absent.
      required:
        - code
        - message
    ProviderResponse:
      type: object
      properties:
        httpStatus:
          type: integer
          description: HTTP status from the provider (e.g. 200, 400, 404, 429, 500).
          example: 200
        error:
          description: Provider error body, passed through faithfully on failure.
    Price:
      type: object
      properties:
        type:
          type: string
        amount:
          type: object
          properties:
            value:
              type: number
            currency:
              type: string
              enum:
                - USD
          required:
            - value
            - currency
        flatFee:
          type: object
          properties:
            value:
              type: number
            currency:
              type: string
              enum:
                - USD
          required:
            - value
            - currency
        period:
          type: object
          properties:
            unit:
              type: string
              enum:
                - MINUTE
                - DAY
                - MONTH
            count:
              type: integer
              exclusiveMinimum: 0
          required:
            - unit
            - count
        per:
          anyOf:
            - type: object
              properties:
                unit:
                  type: string
                  enum:
                    - MINUTE
                    - DAY
                    - MONTH
                count:
                  type: integer
                  exclusiveMinimum: 0
              required:
                - unit
                - count
            - type: number
        unit:
          type: string
          enum:
            - token
            - character
            - second
            - image
            - credit
            - result
            - gb-month
            - step
            - byte
            - url
            - page
        default:
          anyOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - PER_CALL
                amount:
                  type: object
                  properties:
                    value:
                      type: number
                    currency:
                      type: string
                      enum:
                        - USD
                  required:
                    - value
                    - currency
              required:
                - type
                - amount
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - PER_RESULT
                amount:
                  type: object
                  properties:
                    value:
                      type: number
                    currency:
                      type: string
                      enum:
                        - USD
                  required:
                    - value
                    - currency
                flatFee:
                  type: object
                  properties:
                    value:
                      type: number
                    currency:
                      type: string
                      enum:
                        - USD
                  required:
                    - value
                    - currency
              required:
                - type
                - amount
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - METERED
                amount:
                  type: object
                  properties:
                    value:
                      type: number
                    currency:
                      type: string
                      enum:
                        - USD
                  required:
                    - value
                    - currency
                per:
                  type: object
                  properties:
                    unit:
                      type: string
                      enum:
                        - MINUTE
                        - DAY
                        - MONTH
                    count:
                      type: integer
                      exclusiveMinimum: 0
                  required:
                    - unit
                    - count
              required:
                - type
                - amount
                - per
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - PER_UNIT
                amount:
                  type: object
                  properties:
                    value:
                      type: number
                    currency:
                      type: string
                      enum:
                        - USD
                  required:
                    - value
                    - currency
                per:
                  type: number
                unit:
                  type: string
                  enum:
                    - token
                    - character
                    - second
                    - image
                    - credit
                    - result
                    - gb-month
                    - step
                    - byte
                    - url
                    - page
              required:
                - type
                - amount
                - per
                - unit
        selectors:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              key:
                type: string
              in:
                type: string
                enum:
                  - body
                  - queryParam
                  - pathParam
                  - output
              offset:
                type: integer
                minimum: 0
            required:
              - label
              - key
              - in
        variants:
          type: array
          items:
            type: object
            properties:
              when:
                type: object
                additionalProperties:
                  anyOf:
                    - type: string
                    - type: number
                    - type: boolean
              price:
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_CALL
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                    required:
                      - type
                      - amount
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_RESULT
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      flatFee:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                    required:
                      - type
                      - amount
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - METERED
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      per:
                        type: object
                        properties:
                          unit:
                            type: string
                            enum:
                              - MINUTE
                              - DAY
                              - MONTH
                          count:
                            type: integer
                            exclusiveMinimum: 0
                        required:
                          - unit
                          - count
                    required:
                      - type
                      - amount
                      - per
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_UNIT
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      per:
                        type: number
                      unit:
                        type: string
                        enum:
                          - token
                          - character
                          - second
                          - image
                          - credit
                          - result
                          - gb-month
                          - step
                          - byte
                          - url
                          - page
                    required:
                      - type
                      - amount
                      - per
                      - unit
              label:
                type: string
            required:
              - when
              - price
        tiers:
          type: array
          items:
            type: object
            properties:
              label:
                type: string
              when:
                type: object
                additionalProperties:
                  anyOf:
                    - type: string
                    - type: number
                    - type: boolean
              selector:
                type: object
                properties:
                  label:
                    type: string
                  key:
                    type: string
                  in:
                    type: string
                    enum:
                      - body
                      - queryParam
                      - pathParam
                      - output
                  offset:
                    type: integer
                    minimum: 0
                required:
                  - label
                  - key
                  - in
              price:
                anyOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_CALL
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                    required:
                      - type
                      - amount
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_RESULT
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      flatFee:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                    required:
                      - type
                      - amount
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - METERED
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      per:
                        type: object
                        properties:
                          unit:
                            type: string
                            enum:
                              - MINUTE
                              - DAY
                              - MONTH
                          count:
                            type: integer
                            exclusiveMinimum: 0
                        required:
                          - unit
                          - count
                    required:
                      - type
                      - amount
                      - per
                  - type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - PER_UNIT
                      amount:
                        type: object
                        properties:
                          value:
                            type: number
                          currency:
                            type: string
                            enum:
                              - USD
                        required:
                          - value
                          - currency
                      per:
                        type: number
                      unit:
                        type: string
                        enum:
                          - token
                          - character
                          - second
                          - image
                          - credit
                          - result
                          - gb-month
                          - step
                          - byte
                          - url
                          - page
                    required:
                      - type
                      - amount
                      - per
                      - unit
            required:
              - label
              - price
        notes:
          type: array
          items:
            type: string
      required:
        - type
        - amount
      description: User-facing price (markup applied).
    Cost:
      type: object
      properties:
        value:
          type: number
        currency:
          type: string
          enum:
            - USD
      required:
        - value
        - currency
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: >-
        Monid API key (`Authorization: Bearer mk_...`) or Clerk-issued JWT. Each
        operation lists the ONE scope an API key needs. `{resource}:*` grants
        every action on that resource; `*` grants everything; Clerk sessions
        hold `*`. Operations with an empty list need no scope. Scope catalog:
        `GET /v1/api-keys/scopes`.
      x-aep-authentication-method: api-key

````

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