> ## 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. # Request bounded read-only application checks > All IDs authorized before admission; invisible/cross-org target ->404. Per-target transport/offline failures recorded after acceptance. Coalesce identical concurrent reads and apply refresh policy; do not wake, acquire, renew or run an install as a probe. ## OpenAPI ````yaml /api/openapi.json post /v1/app-library/inventory/refreshes 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: /v1/app-library/inventory/refreshes: post: tags: - Apps summary: Request bounded read-only application checks description: >- All IDs authorized before admission; invisible/cross-org target ->404. Per-target transport/offline failures recorded after acceptance. Coalesce identical concurrent reads and apply refresh policy; do not wake, acquire, renew or run an install as a probe. operationId: refreshAppInventory parameters: - name: Idempotency-Key in: header required: true schema: $ref: '#/components/schemas/AppLibraryRequestKey' description: >- Required for an inventory refresh. The same organization, actor, key and canonical request return the original result. A changed intent conflicts. Query the original /requests/{requestKey} after a lost response; no automatic mutation retry. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AppLibraryRefreshInventoryRequest' examples: default: value: packageName: com.example.notes targets: - deviceId: device_01 scopeId: scope_01 responses: '202': description: Accepted; follow returned resource. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Cache-Control: schema: type: string example: private, no-store Idempotency-Replayed: schema: type: boolean description: >- Present on mutations; true only when replaying a durable original response. content: application/json: schema: $ref: '#/components/schemas/AppLibraryInventoryRefresh' examples: default: value: refreshId: refresh_01 state: processing requestedAt: '2026-09-30T18:00:00Z' finishedAt: null targetCount: 1 completedCount: 0 notCompletedCount: 0 nextPollAfterSeconds: 3 servicePromise: promisedBy: '2026-09-30T18:10:00Z' estimatedCompletionAt: '2026-09-30T18:08:00Z' nextUpdateAt: '2026-09-30T18:05:00Z' delayed: false '400': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: invalid_argument message: >- The request could not be accepted. See the error code for the next step. requestId: req_01 field: null retry: none retryAfterSeconds: null '401': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: unauthenticated message: Authenticate before continuing. requestId: req_01 field: null retry: none retryAfterSeconds: null '403': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: permission_denied message: You do not have permission for this action. requestId: req_01 field: null retry: none retryAfterSeconds: null '404': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: not_found message: Resource not found. requestId: req_01 field: null retry: none retryAfterSeconds: null '409': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: idempotency_conflict message: >- The request could not be accepted. See the error code for the next step. requestId: req_01 field: null retry: none retryAfterSeconds: null '413': description: The request exceeds the body limit. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' '429': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: rate_limited message: >- The request could not be accepted. See the error code for the next step. requestId: req_01 field: null retry: same_key_after_delay retryAfterSeconds: 3 '503': description: >- Request rejected or outcome requires recovery. See error.retry; never infer a job failed from HTTP status. Cross-org/invisible IDs use 404. headers: X-Request-Id: schema: $ref: '#/components/schemas/AppLibraryId' description: Sanitized support correlation ID. Retry-After: schema: type: integer minimum: 1 description: For 429/503, when retry is explicitly allowed. content: application/json: schema: $ref: '#/components/schemas/AppLibraryErrorEnvelope' example: error: code: service_unavailable message: >- The request could not be confirmed. Check the original request before continuing. requestId: req_01 field: null retry: query_original retryAfterSeconds: 3 security: - bearerAuth: [] components: schemas: AppLibraryRequestKey: type: string minLength: 1 maxLength: 128 pattern: ^(?!\.{1,2}$)[A-Za-z0-9._:-]+$ description: >- Caller-generated unique intent key, retained by client before sending. New library restriction, not a change to the legacy visible-ASCII key contract. examples: - save.20260930.001 AppLibraryRefreshInventoryRequest: type: object additionalProperties: false properties: packageName: $ref: '#/components/schemas/AppLibraryPackageName' targets: type: array items: $ref: '#/components/schemas/AppLibraryTargetSelection' minItems: 1 maxItems: 100 uniqueItems: true required: - targets description: >- Explicit finite scope. Omit packageName to collect the full installed-app inventory. Pure read only: never acquire/renew leases, wake/boot devices or run a substitute app action. Unsupported read-only transport returns a per-target reason. examples: - packageName: com.example.notes targets: - deviceId: device_01 scopeId: scope_01 AppLibraryId: type: string pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$ examples: - app_01 AppLibraryInventoryRefresh: type: object additionalProperties: false properties: refreshId: $ref: '#/components/schemas/AppLibraryId' state: type: string enum: - processing - completed - partially_completed - not_completed requestedAt: $ref: '#/components/schemas/AppLibraryTimestamp' finishedAt: anyOf: - $ref: '#/components/schemas/AppLibraryTimestamp' - type: 'null' targetCount: type: integer minimum: 1 completedCount: type: integer minimum: 0 notCompletedCount: type: integer minimum: 0 nextPollAfterSeconds: type: integer minimum: 1 servicePromise: $ref: '#/components/schemas/AppLibraryServicePromise' required: - refreshId - state - requestedAt - finishedAt - targetCount - completedCount - notCompletedCount - nextPollAfterSeconds - servicePromise examples: - refreshId: refresh_01 state: processing requestedAt: '2026-09-30T18:00:00Z' finishedAt: null targetCount: 1 completedCount: 0 notCompletedCount: 0 nextPollAfterSeconds: 3 servicePromise: promisedBy: '2026-09-30T18:10:00Z' estimatedCompletionAt: '2026-09-30T18:08:00Z' nextUpdateAt: '2026-09-30T18:05:00Z' delayed: false AppLibraryErrorEnvelope: type: object additionalProperties: false properties: error: $ref: '#/components/schemas/AppLibraryError' required: - error examples: - error: code: preview_changed message: A selected device has changed. Review the devices again. requestId: req_01 field: null retry: new_preview retryAfterSeconds: null AppLibraryPackageName: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)+$ examples: - com.example.notes AppLibraryTargetSelection: type: object additionalProperties: false properties: deviceId: $ref: '#/components/schemas/AppLibraryId' scopeId: $ref: '#/components/schemas/AppLibraryId' required: - deviceId - scopeId examples: - deviceId: device_01 scopeId: scope_01 AppLibraryTimestamp: type: string format: date-time examples: - '2026-09-30T18:00:00Z' AppLibraryServicePromise: type: object additionalProperties: false properties: promisedBy: anyOf: - $ref: '#/components/schemas/AppLibraryTimestamp' - type: 'null' estimatedCompletionAt: anyOf: - $ref: '#/components/schemas/AppLibraryTimestamp' - type: 'null' nextUpdateAt: anyOf: - $ref: '#/components/schemas/AppLibraryTimestamp' - type: 'null' delayed: type: boolean required: - promisedBy - estimatedCompletionAt - nextUpdateAt - delayed description: >- Original promisedBy never resets on retry/poll. nextUpdateAt must correspond to a real scheduled update and accountable service; null does not authorize indefinite waiting. examples: - promisedBy: '2026-09-30T18:10:00Z' estimatedCompletionAt: '2026-09-30T18:08:00Z' nextUpdateAt: '2026-09-30T18:05:00Z' delayed: false AppLibraryError: type: object additionalProperties: false properties: code: $ref: '#/components/schemas/AppLibraryErrorCode' message: type: string requestId: $ref: '#/components/schemas/AppLibraryId' field: anyOf: - type: string - type: 'null' retry: type: string enum: - none - same_key_after_delay - query_original - new_preview retryAfterSeconds: anyOf: - type: integer minimum: 1 - type: 'null' required: - code - message - requestId - field - retry - retryAfterSeconds description: >- Stable PhoneBase business/request error. No provider payloads, signed URLs, stack traces or internal action keys. HTTP error is distinct from a persisted job result. AppLibraryErrorCode: type: string enum: - invalid_argument - unauthenticated - permission_denied - not_found - idempotency_conflict - request_in_progress - idempotency_window_expired - cursor_expired - cursor_mismatch - quota_exceeded - version_unavailable - version_referenced - upload_not_ready - upload_expired - upload_rejected - duplicate_archived - deletion_pending - checksum_mismatch - unsupported_format - metadata_unavailable - preview_expired - preview_changed - target_ineligible - retry_not_safe - rate_limited - feature_unavailable - service_unavailable - precondition_failed - file_too_large securitySchemes: bearerAuth: type: http scheme: bearer description: >- The control surface credential. Send `Authorization: Bearer `. Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning `pbk_` 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.