Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

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

Path Parameters

requestKey
string
required

Caller-generated unique intent key, retained by client before sending. New library restriction, not a change to the legacy visible-ASCII key contract.

Required string length: 1 - 128
Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._:-]+$
Example:

"save.20260930.001"

Response

Successful response.

Read-only lookup under original org and principal, with original operation permissions rechecked. processing describes the HTTP mutation record, not the device job. completed means response durably recorded, not business success. Original job/resource remains authoritative.

requestKey
string
required

Caller-generated unique intent key, retained by client before sending. New library restriction, not a change to the legacy visible-ASCII key contract.

Required string length: 1 - 128
Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._:-]+$
Example:

"save.20260930.001"

operationId
string
required
state
enum<string>
required
Available options:
processing,
completed,
not_completed
resourceType
enum<string> | null
required
Available options:
app,
version,
upload,
deletion,
inventory_refresh,
preview,
job
resourceId
string | null
required
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
Example:

"app_01"

resourcePath
string | null
required
Pattern: ^/v1/app-library/
originalStatus
integer | null
required
Required range: 200 <= x <= 599
createdAt
string<date-time>
required
Example:

"2026-09-30T18:00:00Z"

updatedAt
string<date-time>
required
Example:

"2026-09-30T18:00:00Z"

retainedUntil
string<date-time>
required
Example:

"2026-09-30T18:00:00Z"

error
object | null
required

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.