> ## 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/catalog

> Current minute quotes and paged compute configurations. Unavailable configurations carry no payable quote; available region quote IDs reference the same response quotes. Optional timing identities describe supplier app-facing profiles separately from compute hardware; identity null means automatic allocation, and absent identity facts preserve the legacy path. Requested identities bind immutable original quotes. Optional models/nextCursor/catalogRevision appear together when the model source is configured. Legacy unpaged quotes-only response remains readable; configured model pages cap both arrays at 100. Opaque cursors bind organization, complete business revision, search and requested identity; changes return 409 and require refreshing page one. Target model is mutually exclusive with cursor and q. This read does not dispatch supplier procurement or change previously accepted quote terms.

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/catalog
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/catalog:
    get:
      tags:
        - Minute billing
      summary: /v1/minute/catalog
      description: >-
        Current minute quotes and paged compute configurations. Unavailable
        configurations carry no payable quote; available region quote IDs
        reference the same response quotes. Optional timing identities describe
        supplier app-facing profiles separately from compute hardware; identity
        null means automatic allocation, and absent identity facts preserve the
        legacy path. Requested identities bind immutable original quotes.
        Optional models/nextCursor/catalogRevision appear together when the
        model source is configured. Legacy unpaged quotes-only response remains
        readable; configured model pages cap both arrays at 100. Opaque cursors
        bind organization, complete business revision, search and requested
        identity; changes return 409 and require refreshing page one. Target
        model is mutually exclusive with cursor and q. This read does not
        dispatch supplier procurement or change previously accepted quote terms.


        Hosted deployments only. A local checkout does not mount this route, so
        calling it there is a 404.
      operationId: getV1MinuteCatalog
      parameters:
        - name: limit
          in: query
          required: false
          description: >-
            Maximum model identities, default 100; quote budget may shorten a
            page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: cursor
          in: query
          required: false
          description: Opaque nextCursor from the preceding page, with the same q.
          schema:
            type: string
            minLength: 1
            maxLength: 1024
        - name: model
          in: query
          required: false
          description: >-
            Read one canonical identity, including an off-page saved selection;
            mutually exclusive with q and cursor.
          schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9-]{0,63}$
        - name: q
          in: query
          required: false
          description: >-
            Trimmed case-insensitive substring search over all canonical model
            IDs, names and brands before paging.
          schema:
            type: string
            minLength: 1
            maxLength: 80
        - name: identityId
          in: query
          required: false
          description: >-
            Opaque requested app-facing identity from identities, or any for
            automatic allocation. This choice is separate from compute
            configuration, binds the original quote, and must remain the same
            when following cursor pages.
          schema:
            type: string
            minLength: 1
            maxLength: 160
      responses:
        '200':
          description: Authoritative durable projection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  quotes:
                    type: array
                    items:
                      type: object
                      properties:
                        quoteId:
                          type: string
                        sku:
                          type: string
                        model:
                          type: string
                        region:
                          type: string
                        label:
                          type: string
                        currency:
                          type: string
                        rateMicrosPerMinute:
                          type: string
                          pattern: ^(0|[1-9][0-9]{0,17})$
                          description: >-
                            Integer micros. One settlement-currency unit equals
                            1,000,000 micros.
                        initialFundingMicros:
                          type: string
                          pattern: ^(0|[1-9][0-9]{0,17})$
                          description: >-
                            Integer micros. One settlement-currency unit equals
                            1,000,000 micros.
                        contractVersion:
                          type: string
                        expiresAt:
                          type: string
                          format: date-time
                        quantityMax:
                          type: integer
                          minimum: 0
                        continuousChargeDisclosure:
                          type: string
                        modelSources:
                          type: array
                          items:
                            type: string
                            enum:
                              - byok
                              - external
                              - managed
                        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
                        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'
                      required:
                        - quoteId
                        - sku
                        - label
                        - currency
                        - rateMicrosPerMinute
                        - initialFundingMicros
                        - contractVersion
                        - expiresAt
                        - quantityMax
                        - continuousChargeDisclosure
                        - modelSources
                      additionalProperties: false
                    maxItems: 100
                  models:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^[a-z0-9][a-z0-9-]{0,63}$
                        kind:
                          type: string
                          enum:
                            - standard
                            - branded
                        name:
                          type: string
                        brand:
                          type: string
                          minLength: 1
                        androidVersion:
                          type: string
                          minLength: 1
                        spec:
                          type: string
                          minLength: 1
                        currency:
                          type: string
                          enum:
                            - USD
                        rateMicrosPerMinute:
                          type: string
                          pattern: ^(0|[1-9][0-9]{0,17})$
                          description: >-
                            Integer micros. One settlement-currency unit equals
                            1,000,000 micros.
                        available:
                          type: boolean
                        regions:
                          type: array
                          items:
                            type: object
                            properties:
                              code:
                                type: string
                                pattern: ^[A-Z]{2}$
                              available:
                                type: boolean
                              quoteId:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                            required:
                              - code
                              - available
                              - quoteId
                            additionalProperties: false
                      required:
                        - id
                        - kind
                        - name
                        - currency
                        - rateMicrosPerMinute
                        - available
                        - regions
                      additionalProperties: false
                    maxItems: 100
                  identities:
                    type: array
                    items:
                      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
                    maxItems: 500
                  identityRevision:
                    type: string
                  identitySelection:
                    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'
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                  catalogRevision:
                    type: string
                    pattern: ^[a-f0-9]{64}$
                  updatedAt:
                    type: string
                    format: date-time
                required:
                  - quotes
                  - updatedAt
                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.