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

# List the run's device

> Returns exactly one device: the one this run is bound to. A run token is never a fleet listing, and it cannot be walked sideways onto another device.

This operation reads no `Authorization` header. The run token in the path IS the credential, so the whole url is secret: never log it, paste it, or commit it. Every example writes `{runToken}` for that reason.



## OpenAPI

````yaml /api/openapi.json get /vrx/{runToken}/v1/devices
openapi: 3.1.0
info:
  title: Phonebase 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-phonebase-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.phonebase.co
        enum:
          - https://mcp.phonebase.co
          - 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: Apps
    description: Save immutable application builds and manage explicit device operations.
  - name: Managed Proxy
    description: >-
      Organization-owned fixed egress resources, independent one-time orders and
      verified network relationships.
  - name: Health
    description: Liveness, unauthenticated.
  - name: Gateway enrollment
    description: >-
      How a new gateway computer trades a one-time enrollment code for its
      tunnel credential. Unauthenticated: the code is the credential.
  - name: Gateway releases
    description: >-
      What a gateway computer installs: the current edge release of a channel.
      Called with the gateway's own credential.
  - 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:
  /vrx/{runToken}/v1/devices:
    get:
      tags:
        - Device surface
      summary: List the run's device
      description: >-
        Returns exactly one device: the one this run is bound to. A run token is
        never a fleet listing, and it cannot be walked sideways onto another
        device.


        This operation reads no `Authorization` header. The run token in the
        path IS the credential, so the whole url is secret: never log it, paste
        it, or commit it. Every example writes `{runToken}` for that reason.
      operationId: getVrxByRunTokenV1Devices
      parameters:
        - name: runToken
          in: path
          required: true
          description: The run token. Write `{runToken}`; never write a real one down.
          schema:
            type: string
      responses:
        '200':
          description: The run's device and what it can do.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceListing'
        '404':
          description: >-
            Unknown, expired, terminal, or addressed at a device this run does
            not own. All four answer identically, so holding a token tells you
            nothing about which it was.


            If you reached this with an org API key rather than a run token, the
            code is misleading and the message says so: nothing is missing, this
            is the worker channel and your credential does not apply to it.
            Drive devices yourself over the MCP endpoint instead.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceError'
        '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: The device is not reachable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceError'
      security: []
components:
  schemas:
    DeviceListing:
      type: object
      properties:
        ok:
          type: boolean
        protocol:
          type: string
        devices:
          type: array
          description: Exactly the run's own device. This surface is never a fleet listing.
          items:
            type: object
            properties:
              id:
                type: string
                description: >-
                  The device id the control plane uses. The backend's own id is
                  never exposed.
              name:
                type: string
              platform:
                type: string
                description: The device operating system.
              ready:
                type: boolean
                description: True when the device is online.
              capabilities:
                type: object
                properties:
                  screenshot:
                    type: boolean
                  tap:
                    type: boolean
                  swipe:
                    type: boolean
                  type_text:
                    type: boolean
                  open_app:
                    type: boolean
                  press_button:
                    description: >-
                      False when unsupported, otherwise the set of buttons this
                      device accepts.
                    oneOf:
                      - type: boolean
                      - type: array
                        items:
                          type: string
                          enum:
                            - home
                            - back
                            - enter
                            - delete
                            - app_switch
                            - power
                            - volume_up
                            - volume_down
                          description: A pressable button.
                required:
                  - screenshot
                  - tap
                  - swipe
                  - type_text
                  - open_app
                  - press_button
                additionalProperties: false
            required:
              - id
              - name
              - platform
              - ready
              - capabilities
            additionalProperties: false
      required:
        - ok
        - protocol
        - devices
      additionalProperties: false
    DeviceError:
      type: object
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - DEVICE_NOT_FOUND
                - INVALID_ACTION
                - FRAME_VIEWPORT_MISMATCH
                - COORDINATE_OUT_OF_REACH
                - ACTION_UNAVAILABLE
                - FENCING_TOKEN_STALE
                - STALE_FRAME
                - HARDWARE_OFFLINE
                - FRAME_UNAVAILABLE
                - ACTION_OUTCOME_UNKNOWN
              description: The dialect code to branch on.
            message:
              type: string
              description: >-
                A constant summary per branch. Internal error text is never
                forwarded here.
            details:
              type: object
              description: >-
                Structured detail for the branches that have any (spec §8,
                §15.4). `STALE_FRAME` carries `reason` (`unknown_frame`,
                `superseded`, `expired`, `viewport_changed`, `others_acted`;
                read anything else as `unknown_frame`), and an
                `ACTION_UNAVAILABLE` raised by a full device queue carries
                `retryAfterMs`. Absent on every other branch, and it never
                carries internal text.
              additionalProperties: true
          required:
            - code
            - message
          additionalProperties: false
      required:
        - ok
        - error
      additionalProperties: false
      description: >-
        The device surface answers in the dialect's own error shape, not the
        control surface envelope.
    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.

````

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