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

# /v1/minute/starts/:id

> One start by its requestId. Reading it also checks an open payment with Stripe and, if paid within the hour, places the order once, like the background sweep. Includes the top-up (payment starts) and the order once it exists.

Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.



## OpenAPI

````yaml /api/openapi.json get /v1/minute/starts/{id}
openapi: 3.1.0
info:
  title: PhoneUse HTTP API
  version: 0.1.0
  summary: >-
    Every HTTP operation the control plane mounts, generated from the app's own
    route table.
  description: >-
    The control plane exposes two HTTP surfaces, and reading the boundary
    between them matters more than reading any single endpoint.


    The CONTROL surface is what your backend and your operators call. It takes a
    bearer token in the `Authorization` header, and two credential channels
    resolve to the same authorization context: an OAuth 2.1 access token for
    interactive clients, or an org scoped API key for headless ones.


    The DEVICE surface, under `/vrx/{runToken}/v1`, is what a worker calls while
    executing one run. Its credential is the run token in the url path, and it
    reads no `Authorization` header at all.


    Device control itself is not REST. An agent taps, swipes and reads the
    screen over the Model Context Protocol at `POST /mcp`, one tool call at a
    time. There is no `POST /v1/devices/{id}/tap`, and if you are looking for
    one, start with the tool reference instead.


    Operations marked `"x-phoneuse-modes": ["hosted"]` exist only on a hosted
    deployment; a local checkout does not mount them.
servers:
  - url: '{origin}'
    description: Your control plane origin.
    variables:
      origin:
        default: https://mcp.phoneuse.com
        enum:
          - https://mcp.phoneuse.com
          - http://127.0.0.1:8788
        description: >-
          The hosted deployment serves the public origin its metadata document
          advertises, and that is the default here. Select the loopback entry
          instead when you are running a local checkout, which serves the port
          `PORT` names.
security: []
tags:
  - name: Robot purchases
    description: >-
      Monthly robot checkout and initial purchase receipts. Delivery remains not
      delivered.
  - name: Managed Proxy
    description: >-
      Organization-owned network resources, original payments and verified phone
      connections.
  - name: Minute billing
    description: Private prepaid minute contract projections and recoverable requests.
  - name: Apps
    description: Save immutable application builds and manage explicit device operations.
  - name: Health
    description: Liveness, unauthenticated.
  - name: MCP
    description: The JSON-RPC endpoint an agent drives devices through.
  - name: Copilot
    description: >-
      Drive a device by chatting. A signed in person's own conversations,
      streamed. Hosted deployments only.
  - name: Discovery
    description: Where to authenticate. Served on hosted deployments only.
  - name: Runs
    description: Start, watch and steer a run.
  - name: API keys
    description: Mint and revoke headless credentials. Hosted deployments only.
  - name: Device surface
    description: What a worker calls with its run token to observe and act.
  - name: Usage
    description: Read your org's own receipts and consumption. Hosted deployments only.
  - name: Devices
    description: Read the fleet your credential can see. Hosted deployments only.
  - name: Notifications
    description: >-
      What a person needs to know when they are not watching, and which emails
      they receive. Hosted deployments only.
  - name: Webhooks
    description: >-
      Subscribe your own system to what happens here, and read what was
      delivered. Hosted deployments only.
  - name: Provisioning
    description: >-
      Whether an organisation is provisioned, and how it becomes so. Hosted
      deployments only, and both operations answer a declared 503 on a
      deployment that cannot provision yet.
paths:
  /v1/minute/starts/{id}:
    get:
      tags:
        - Minute billing
      summary: /v1/minute/starts/:id
      description: >-
        One start by its requestId. Reading it also checks an open payment with
        Stripe and, if paid within the hour, places the order once, like the
        background sweep. Includes the top-up (payment starts) and the order
        once it exists.


        Hosted deployments only. A local checkout does not mount this route, so
        calling it there is a 404.
      operationId: getV1MinuteStartsById
      parameters:
        - name: id
          in: path
          required: true
          description: Stable original operation identifier.
          schema:
            type: string
      responses:
        '200':
          description: Authoritative durable projection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  start:
                    type: object
                    properties:
                      id:
                        type: string
                      state:
                        type: string
                        enum:
                          - waiting_payment
                          - starting
                          - started
                          - replaced
                          - expired
                          - not_started
                        description: >-
                          waiting_payment = the Checkout is open; starting =
                          paid within the hour, the order is being placed;
                          started = the order exists (orderId); replaced = a
                          newer start or top-up came first, its payment only
                          adds to the balance; expired = paid more than an hour
                          after the selection, balance only; not_started = the
                          money stays in the balance, see reason.
                      model:
                        type: string
                      region:
                        type: string
                      identityId:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: Requested app-facing identity, or null for automatic.
                      quantity:
                        type: integer
                        minimum: 1
                        maximum: 1000
                      rateMicrosPerMinute:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,17})$
                        description: >-
                          Integer micros. One settlement-currency unit equals
                          1,000,000 micros.
                      startMicrosPerPhone:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,17})$
                        description: >-
                          Money held per phone when it starts (10 minutes of its
                          rate).
                      topupId:
                        type: string
                        description: >-
                          The top-up carrying this selection; absent when the
                          phones started from the balance.
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      paidAt:
                        type: string
                        format: date-time
                      orderId:
                        type: string
                      reason:
                        type: string
                        enum:
                          - sold_out
                          - rate_changed
                          - price_ceiling
                          - insufficient_funds
                          - unavailable
                          - checkout_closed
                        description: >-
                          Only with not_started. sold_out = the supplier has no
                          such phone now; rate_changed = the per-minute rate or
                          its version changed; price_ceiling = the supplier
                          charges more than the customer price;
                          insufficient_funds = running phones used the balance
                          first; unavailable = phone sales were off or could not
                          be read for an hour; checkout_closed = the Checkout
                          closed unpaid.
                    required:
                      - id
                      - state
                      - model
                      - region
                      - identityId
                      - quantity
                      - rateMicrosPerMinute
                      - startMicrosPerPhone
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                  topup:
                    oneOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          requestId:
                            type: string
                          status:
                            type: string
                            enum:
                              - pending
                              - unknown
                              - confirmed
                              - failed
                          currency:
                            type: string
                          paymentUrl:
                            type: string
                            format: uri
                          closeReason:
                            type: string
                            enum:
                              - abandoned
                              - replaced
                              - expired
                            description: >-
                              Only with status failed: the Checkout was closed
                              unpaid, not declined. abandoned = the customer
                              came back without paying; replaced = a newer
                              top-up was started; expired = Checkout timed out
                              with no payment attempt. No failure notice is sent
                              for these.
                          returnQuoteId:
                            type: string
                          returnQuantity:
                            type: integer
                            minimum: 0
                          quoteId:
                            type: string
                          termsVersion:
                            type: string
                          updatedAt:
                            type: string
                            format: date-time
                          start:
                            type: object
                            properties:
                              id:
                                type: string
                              state:
                                type: string
                                enum:
                                  - waiting_payment
                                  - starting
                                  - started
                                  - replaced
                                  - expired
                                  - not_started
                                description: >-
                                  waiting_payment = the Checkout is open;
                                  starting = paid within the hour, the order is
                                  being placed; started = the order exists
                                  (orderId); replaced = a newer start or top-up
                                  came first, its payment only adds to the
                                  balance; expired = paid more than an hour
                                  after the selection, balance only; not_started
                                  = the money stays in the balance, see reason.
                              model:
                                type: string
                              region:
                                type: string
                              identityId:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                                description: >-
                                  Requested app-facing identity, or null for
                                  automatic.
                              quantity:
                                type: integer
                                minimum: 1
                                maximum: 1000
                              rateMicrosPerMinute:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                              startMicrosPerPhone:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Money held per phone when it starts (10
                                  minutes of its rate).
                              topupId:
                                type: string
                                description: >-
                                  The top-up carrying this selection; absent
                                  when the phones started from the balance.
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                              paidAt:
                                type: string
                                format: date-time
                              orderId:
                                type: string
                              reason:
                                type: string
                                enum:
                                  - sold_out
                                  - rate_changed
                                  - price_ceiling
                                  - insufficient_funds
                                  - unavailable
                                  - checkout_closed
                                description: >-
                                  Only with not_started. sold_out = the supplier
                                  has no such phone now; rate_changed = the
                                  per-minute rate or its version changed;
                                  price_ceiling = the supplier charges more than
                                  the customer price; insufficient_funds =
                                  running phones used the balance first;
                                  unavailable = phone sales were off or could
                                  not be read for an hour; checkout_closed = the
                                  Checkout closed unpaid.
                            required:
                              - id
                              - state
                              - model
                              - region
                              - identityId
                              - quantity
                              - rateMicrosPerMinute
                              - startMicrosPerPhone
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                            description: >-
                              Present when this top-up was opened by POST
                              /v1/minute/starts: the phone selection it pays for
                              and where it stands.
                          principalMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          taxMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          feeMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          totalMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          taxBehavior:
                            type: string
                            enum:
                              - exclusive
                        required:
                          - id
                          - requestId
                          - status
                          - currency
                          - principalMicros
                          - taxMicros
                          - feeMicros
                          - totalMicros
                          - updatedAt
                        additionalProperties: false
                      - type: object
                        properties:
                          id:
                            type: string
                          requestId:
                            type: string
                          status:
                            type: string
                            enum:
                              - pending
                              - unknown
                              - failed
                          currency:
                            type: string
                          paymentUrl:
                            type: string
                            format: uri
                          closeReason:
                            type: string
                            enum:
                              - abandoned
                              - replaced
                              - expired
                            description: >-
                              Only with status failed: the Checkout was closed
                              unpaid, not declined. abandoned = the customer
                              came back without paying; replaced = a newer
                              top-up was started; expired = Checkout timed out
                              with no payment attempt. No failure notice is sent
                              for these.
                          returnQuoteId:
                            type: string
                          returnQuantity:
                            type: integer
                            minimum: 0
                          quoteId:
                            type: string
                          termsVersion:
                            type: string
                          updatedAt:
                            type: string
                            format: date-time
                          start:
                            type: object
                            properties:
                              id:
                                type: string
                              state:
                                type: string
                                enum:
                                  - waiting_payment
                                  - starting
                                  - started
                                  - replaced
                                  - expired
                                  - not_started
                                description: >-
                                  waiting_payment = the Checkout is open;
                                  starting = paid within the hour, the order is
                                  being placed; started = the order exists
                                  (orderId); replaced = a newer start or top-up
                                  came first, its payment only adds to the
                                  balance; expired = paid more than an hour
                                  after the selection, balance only; not_started
                                  = the money stays in the balance, see reason.
                              model:
                                type: string
                              region:
                                type: string
                              identityId:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                                description: >-
                                  Requested app-facing identity, or null for
                                  automatic.
                              quantity:
                                type: integer
                                minimum: 1
                                maximum: 1000
                              rateMicrosPerMinute:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                              startMicrosPerPhone:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Money held per phone when it starts (10
                                  minutes of its rate).
                              topupId:
                                type: string
                                description: >-
                                  The top-up carrying this selection; absent
                                  when the phones started from the balance.
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                              paidAt:
                                type: string
                                format: date-time
                              orderId:
                                type: string
                              reason:
                                type: string
                                enum:
                                  - sold_out
                                  - rate_changed
                                  - price_ceiling
                                  - insufficient_funds
                                  - unavailable
                                  - checkout_closed
                                description: >-
                                  Only with not_started. sold_out = the supplier
                                  has no such phone now; rate_changed = the
                                  per-minute rate or its version changed;
                                  price_ceiling = the supplier charges more than
                                  the customer price; insufficient_funds =
                                  running phones used the balance first;
                                  unavailable = phone sales were off or could
                                  not be read for an hour; checkout_closed = the
                                  Checkout closed unpaid.
                            required:
                              - id
                              - state
                              - model
                              - region
                              - identityId
                              - quantity
                              - rateMicrosPerMinute
                              - startMicrosPerPhone
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                            description: >-
                              Present when this top-up was opened by POST
                              /v1/minute/starts: the phone selection it pays for
                              and where it stands.
                          taxBehavior:
                            type: string
                            enum:
                              - inclusive
                          fundingCreditMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          principalMicros:
                            type: 'null'
                          taxMicros:
                            type: 'null'
                          feeMicros:
                            type: string
                            const: '0'
                          totalMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          accountingStatus:
                            type: string
                            enum:
                              - pending
                        required:
                          - id
                          - requestId
                          - status
                          - currency
                          - principalMicros
                          - taxMicros
                          - feeMicros
                          - totalMicros
                          - updatedAt
                          - taxBehavior
                          - fundingCreditMicros
                          - accountingStatus
                        additionalProperties: false
                      - type: object
                        properties:
                          id:
                            type: string
                          requestId:
                            type: string
                          status:
                            type: string
                            enum:
                              - confirmed
                          currency:
                            type: string
                          paymentUrl:
                            type: string
                            format: uri
                          closeReason:
                            type: string
                            enum:
                              - abandoned
                              - replaced
                              - expired
                            description: >-
                              Only with status failed: the Checkout was closed
                              unpaid, not declined. abandoned = the customer
                              came back without paying; replaced = a newer
                              top-up was started; expired = Checkout timed out
                              with no payment attempt. No failure notice is sent
                              for these.
                          returnQuoteId:
                            type: string
                          returnQuantity:
                            type: integer
                            minimum: 0
                          quoteId:
                            type: string
                          termsVersion:
                            type: string
                          updatedAt:
                            type: string
                            format: date-time
                          start:
                            type: object
                            properties:
                              id:
                                type: string
                              state:
                                type: string
                                enum:
                                  - waiting_payment
                                  - starting
                                  - started
                                  - replaced
                                  - expired
                                  - not_started
                                description: >-
                                  waiting_payment = the Checkout is open;
                                  starting = paid within the hour, the order is
                                  being placed; started = the order exists
                                  (orderId); replaced = a newer start or top-up
                                  came first, its payment only adds to the
                                  balance; expired = paid more than an hour
                                  after the selection, balance only; not_started
                                  = the money stays in the balance, see reason.
                              model:
                                type: string
                              region:
                                type: string
                              identityId:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                                description: >-
                                  Requested app-facing identity, or null for
                                  automatic.
                              quantity:
                                type: integer
                                minimum: 1
                                maximum: 1000
                              rateMicrosPerMinute:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                              startMicrosPerPhone:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Money held per phone when it starts (10
                                  minutes of its rate).
                              topupId:
                                type: string
                                description: >-
                                  The top-up carrying this selection; absent
                                  when the phones started from the balance.
                              createdAt:
                                type: string
                                format: date-time
                              updatedAt:
                                type: string
                                format: date-time
                              paidAt:
                                type: string
                                format: date-time
                              orderId:
                                type: string
                              reason:
                                type: string
                                enum:
                                  - sold_out
                                  - rate_changed
                                  - price_ceiling
                                  - insufficient_funds
                                  - unavailable
                                  - checkout_closed
                                description: >-
                                  Only with not_started. sold_out = the supplier
                                  has no such phone now; rate_changed = the
                                  per-minute rate or its version changed;
                                  price_ceiling = the supplier charges more than
                                  the customer price; insufficient_funds =
                                  running phones used the balance first;
                                  unavailable = phone sales were off or could
                                  not be read for an hour; checkout_closed = the
                                  Checkout closed unpaid.
                            required:
                              - id
                              - state
                              - model
                              - region
                              - identityId
                              - quantity
                              - rateMicrosPerMinute
                              - startMicrosPerPhone
                              - createdAt
                              - updatedAt
                            additionalProperties: false
                            description: >-
                              Present when this top-up was opened by POST
                              /v1/minute/starts: the phone selection it pays for
                              and where it stands.
                          taxBehavior:
                            type: string
                            enum:
                              - inclusive
                          fundingCreditMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          principalMicros:
                            type: 'null'
                          taxMicros:
                            type: 'null'
                          feeMicros:
                            type: string
                            const: '0'
                          totalMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          accountingStatus:
                            type: string
                            enum:
                              - confirmed
                          paymentAccounting:
                            type: object
                            properties:
                              principalMicros:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                              taxMicros:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                              totalMicros:
                                type: string
                                pattern: ^(0|[1-9][0-9]{0,17})$
                                description: >-
                                  Integer micros. One settlement-currency unit
                                  equals 1,000,000 micros.
                            required:
                              - principalMicros
                              - taxMicros
                              - totalMicros
                            additionalProperties: false
                        required:
                          - id
                          - requestId
                          - status
                          - currency
                          - principalMicros
                          - taxMicros
                          - feeMicros
                          - totalMicros
                          - updatedAt
                          - taxBehavior
                          - fundingCreditMicros
                          - accountingStatus
                          - paymentAccounting
                        additionalProperties: false
                  order:
                    type: object
                    properties:
                      identity:
                        anyOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              brand:
                                type: string
                              androidVersion:
                                type: string
                              revision:
                                type: string
                            required:
                              - id
                              - name
                              - brand
                              - androidVersion
                              - revision
                            additionalProperties: false
                          - type: 'null'
                      managedModelTerms:
                        type: object
                        properties:
                          model:
                            type: string
                          label:
                            type: string
                          currency:
                            type: string
                          maximumMicros:
                            type: string
                            pattern: ^(0|[1-9][0-9]{0,17})$
                            description: >-
                              Integer micros. One settlement-currency unit
                              equals 1,000,000 micros.
                          priceVersion:
                            type: string
                          contractVersion:
                            type: string
                          chargingDisclosure:
                            type: string
                        required:
                          - model
                          - label
                          - currency
                          - maximumMicros
                          - priceVersion
                          - contractVersion
                          - chargingDisclosure
                        additionalProperties: false
                      id:
                        type: string
                      requestId:
                        type: string
                      quoteId:
                        type: string
                      status:
                        type: string
                        enum:
                          - waiting
                          - partial
                          - ready
                          - cancelled
                      canCancel:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            status:
                              type: string
                              enum:
                                - waiting
                                - ready
                                - cancelled
                            deviceId:
                              type: string
                            activation:
                              type: string
                              format: date-time
                            rentalId:
                              type: string
                            cancelReason:
                              type: string
                              enum:
                                - supplier_sold_out
                                - supplier_refused
                              description: >-
                                Present only on a cancelled unit that the
                                supplier could not supply. `supplier_sold_out`
                                means no phone was available; `supplier_refused`
                                means the supplier declined to start it. The
                                held minutes are returned to the minute balance.
                                A unit the customer cancelled has no
                                `cancelReason`.
                          required:
                            - id
                            - status
                          additionalProperties: false
                      nextUpdateAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                        description: >-
                          A backed customer update commitment when available;
                          null means no estimate is promised.
                      revision:
                        type: integer
                        minimum: 1
                        description: >-
                          Monotonic order business projection revision; reads
                          and authorization extension do not increment it.
                      updatedAt:
                        type: string
                        format: date-time
                      createdAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - requestId
                      - quoteId
                      - status
                      - canCancel
                      - units
                      - nextUpdateAt
                      - revision
                      - updatedAt
                      - createdAt
                    additionalProperties: false
                required:
                  - start
                additionalProperties: false
        '400':
          description: Invalid fields.
        '401':
          description: Authentication required.
        '402':
          description: Insufficient available funds.
        '403':
          description: Current role does not authorize this operation.
        '404':
          description: Original record not found.
        '409':
          description: Idempotency body, service or affected work changed.
        '429':
          description: >-
            Over the request budget for this caller. Hosted deployments only.
            Which budget applied depends on whether this request carried an
            `Authorization` header, not on which endpoint it was aimed at. Wait
            `Retry-After` seconds and retry the same request: the refusal
            happens before any work, so nothing was partially applied. See
            /api/rate-limits.
          headers:
            Retry-After:
              description: >-
                Whole seconds until one request is available again. Computed
                from the caller's own remaining allowance, not a fixed constant.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The budget in effect for this caller class, in requests per
                minute.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                Whole requests that were still available when this request was
                admitted. Zero on a 429.
              schema:
                type: string
            RateLimit-Reset:
              description: >-
                Seconds until the allowance is back to full. Longer than
                `Retry-After`, which is the wait for a single request.
              schema:
                type: string
            RateLimit-Policy:
              description: The budget and its window, as `<limit>;w=60`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitedError'
        '503':
          description: >-
            Policy or dependency unavailable; no new financial operation
            performed.
      security:
        - bearerAuth: []
components:
  schemas:
    RateLimitedError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              const: rate_limited
              description: Always `rate_limited` on this response.
            message:
              type: string
              description: >-
                A human readable summary. The numbers are in the headers, not in
                here.
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        Over the request budget. Raised by the rate limiter before any handler
        runs, which is why its code is not one of the action codes: nothing was
        attempted, so no action failed.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The control surface credential. Send `Authorization: Bearer <token>`.


        Two kinds of token are accepted and they are told apart by shape, not by
        a separate header. A token beginning `pbk_` or `puk_` is an org scoped
        API key, whose public half and secret half are generated together and of
        which only a hash of the secret is ever stored; anything else is treated
        as an OAuth 2.1 access token and verified against the authorization
        server's keys.


        Both resolve to the same context: an org, a principal and a set of
        scopes. Nothing downstream branches on which channel you used, with one
        deliberate exception, key management, which requires a signed-in person
        so that a key can never mint another key.


        Scopes are enforced when MCP tools are REGISTERED rather than when they
        are called, so a tool your credential cannot use is absent from
        `tools/list` rather than refused mid gesture.

````

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