One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device’s resolution.
WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent’s run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person’s gesture slides a lease THEY hold when it is running low; it never extends anybody else’s.
DRIVING BESIDE AN AGENT. A person’s tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person’s go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture’s turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel.
The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status.
Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice.
A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type.
Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.
POST
/
v1
/
devices
/
{deviceId}
/
actions
Error
A valid request URL is required to generate request examples
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.
Path Parameters
deviceId
string
required
The device to act on.
Body
application/json
One gesture.
tap
swipe
long_press
type_text
press_key
open_app
rotate
One gesture, discriminated by action. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.
leaseId is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (devices:lease). A leaseId you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.
refuseIfOthersActed refuses the gesture if anybody else acted on the device after observedFrame was taken. It is on by default for an API key that sends observedFrame, off for a person, and off without a frame; send it explicitly to choose.
action
string
required
Allowed value: "tap"
x
number
required
Required range: 0 <= x <= 1000
y
number
required
Required range: 0 <= x <= 1000
leaseId
string
Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without devices:lease is refused lease_required instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused lease_required rather than turned into a new take.
refuseIfOthersActed
boolean
Refuse this gesture (409 stale_frame, reason others_acted) if another principal acted on the device after observedFrame was taken. Sending true needs observedFrame; without it the body is refused as invalid_argument. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends observedFrame, off for a person acting directly, and off whenever no observedFrame is sent. You are told through others either way.
idempotencyKey
string
Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with "agent:", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.
observedFrame
string
The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.
Response
The device applied it.
deviceId
string
required
The device the gesture was applied to.
leaseId
string
required
The lease the gesture ran under: the one you named, your organisation's current one, or the one taken for you. Keep it if you want to release a lease this call took for you; nothing else needs it.
coDriving
boolean
required
True when the lease belongs to somebody else inside your organisation, an agent's run most often: you acted beside them, and they were informed through their own others. False when it is yours.
status
string
required
The device applied it. There is no other success.
Allowed value: "committed"
committedAt
string
required
ISO-8601 instant the device confirmed it, on this service's clock.
others
object
required
What everybody else did on this device since you last looked. On a gesture the anchor is the frame you bound it to, else your previous gesture that reached the device (a refused one never anchors), else the last sixty seconds. A person may drive the same device beside an agent's run; each is informed of the other through this and neither is stopped.
Show child attributes
idempotencyKey
string
The key this action was deduplicated under, whether you sent it or the service generated it.
deduplicated
boolean
True when this outcome was replayed from the ledger and the device was NOT touched again. Absent means the gesture really happened just now.
frameNotes
object
What the robot arm noticed about the frame this action was bound to. The arm no longer refuses an old or overtaken frame: it performs the gesture and reports here, and you decide whether to take a new screenshot before the next one. Present only on a robot-driven phone whose controller reports it, and only on an action that was bound to a frame; any field may be missing.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PhoneUse","description":"The mobile execution layer for AI agents.","colors":{"primary":"#0c6b4f","light":"#12a06a","dark":"#0a5a43"},"logo":{"light":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b","dark":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=82325f8969ce89102cc6e3af558a4436","href":"https://phoneuse.com"},"favicon":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/favicon.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=5aebe1e05fdad8394b3f4d54e6e75f22","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Main site","href":"https://phoneuse.com"}},"footer":{"socials":{"website":"https://phoneuse.com"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phonebase","hasAudioNarration":false,"actualSubdomain":"phonebase","customDomains":["docs.phoneuse.com"],"gitSource":{"type":"github","owner":"phoneuse-official","repo":"phoneuse-api","deployBranch":"docs-release","contentDirectory":"docs/site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afd0a6c8745fb0d64fce35c","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API","count":158},{"language":"default","tag":"Endpoints","count":155},{"language":"default","tag":"Docs","count":34},{"language":"default","tag":"Managed Proxy","count":22},{"language":"default","tag":"Minute billing","count":22},{"language":"default","tag":"Devices","count":19},{"language":"default","tag":"Apps","count":18},{"language":"default","tag":"Provisioning","count":14},{"language":"default","tag":"API keys","count":12},{"language":"default","tag":"Copilot","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/endpoints/devices/act-on-a-device","slug":"/api/endpoints/devices/act-on-a-device","pageMetadata":{"title":"Act on a device","description":"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device's resolution.\n\nWHOSE LEASE. Any caller may leave `leaseId` out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent's run, a colleague, you), and the response says so in `coDriving`. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs `devices:lease`: a key with only `devices:act` acts on a device its organisation already holds. A signed-in person's gesture slides a lease THEY hold when it is running low; it never extends anybody else's.\n\nDRIVING BESIDE AN AGENT. A person's tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person's go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture's turn comes (one that ended while it waited answers `lease_required`), each one is receipted with who took it, and every result carries `others`: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: `POST /v1/runs/{runId}/pause` and `POST /v1/runs/{runId}/cancel`.\n\nThe response resolves only once the DEVICE applied the gesture. `status` has one value, and an action that did not commit is an error rather than a different status.\n\nEvery attempt is on the receipt ledger before it is dispatched, so `GET /v1/receipts` can answer what happened even when this response is lost. Send your own `idempotencyKey` and a retry replays that outcome instead of touching the phone twice.\n\nA device may refuse a gesture it cannot perform; read its `capabilities` first. A robot arm, for instance, can tap and swipe and cannot type.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/actions","href":"/api/endpoints/devices/act-on-a-device","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device’s resolution.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"WHOSE LEASE. Any caller may leave \", _jsx(_components.code, {\n children: \"leaseId\"\n }), \" out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent’s run, a colleague, you), and the response says so in \", _jsx(_components.code, {\n children: \"coDriving\"\n }), \". When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs \", _jsx(_components.code, {\n children: \"devices:lease\"\n }), \": a key with only \", _jsx(_components.code, {\n children: \"devices:act\"\n }), \" acts on a device its organisation already holds. A signed-in person’s gesture slides a lease THEY hold when it is running low; it never extends anybody else’s.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"DRIVING BESIDE AN AGENT. A person’s tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person’s go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture’s turn comes (one that ended while it waited answers \", _jsx(_components.code, {\n children: \"lease_required\"\n }), \"), each one is receipted with who took it, and every result carries \", _jsx(_components.code, {\n children: \"others\"\n }), \": what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: \", _jsx(_components.code, {\n children: \"POST /v1/runs/{runId}/pause\"\n }), \" and \", _jsx(_components.code, {\n children: \"POST /v1/runs/{runId}/cancel\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response resolves only once the DEVICE applied the gesture. \", _jsx(_components.code, {\n children: \"status\"\n }), \" has one value, and an action that did not commit is an error rather than a different status.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Every attempt is on the receipt ledger before it is dispatched, so \", _jsx(_components.code, {\n children: \"GET /v1/receipts\"\n }), \" can answer what happened even when this response is lost. Send your own \", _jsx(_components.code, {\n children: \"idempotencyKey\"\n }), \" and a retry replays that outcome instead of touching the phone twice.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A device may refuse a gesture it cannot perform; read its \", _jsx(_components.code, {\n children: \"capabilities\"\n }), \" first. A robot arm, for instance, can tap and swipe and cannot type.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Act on a device","description":"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device's resolution.\n\nWHOSE LEASE. Any caller may leave `leaseId` out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent's run, a colleague, you), and the response says so in `coDriving`. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs `devices:lease`: a key with only `devices:act` acts on a device its organisation already holds. A signed-in person's gesture slides a lease THEY hold when it is running low; it never extends anybody else's.\n\nDRIVING BESIDE AN AGENT. A person's tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person's go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture's turn comes (one that ended while it waited answers `lease_required`), each one is receipted with who took it, and every result carries `others`: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: `POST /v1/runs/{runId}/pause` and `POST /v1/runs/{runId}/cancel`.\n\nThe response resolves only once the DEVICE applied the gesture. `status` has one value, and an action that did not commit is an error rather than a different status.\n\nEvery attempt is on the receipt ledger before it is dispatched, so `GET /v1/receipts` can answer what happened even when this response is lost. Send your own `idempotencyKey` and a retry replays that outcome instead of touching the phone twice.\n\nA device may refuse a gesture it cannot perform; read its `capabilities` first. A robot arm, for instance, can tap and swipe and cannot type.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/actions","href":"/api/endpoints/devices/act-on-a-device","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postV1DevicesByDeviceIdActions","tags":["Devices"],"summary":"Act on a device","description":"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device's resolution.\n\nWHOSE LEASE. Any caller may leave `leaseId` out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent's run, a colleague, you), and the response says so in `coDriving`. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs `devices:lease`: a key with only `devices:act` acts on a device its organisation already holds. A signed-in person's gesture slides a lease THEY hold when it is running low; it never extends anybody else's.\n\nDRIVING BESIDE AN AGENT. A person's tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person's go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture's turn comes (one that ended while it waited answers `lease_required`), each one is receipted with who took it, and every result carries `others`: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: `POST /v1/runs/{runId}/pause` and `POST /v1/runs/{runId}/cancel`.\n\nThe response resolves only once the DEVICE applied the gesture. `status` has one value, and an action that did not commit is an error rather than a different status.\n\nEvery attempt is on the receipt ledger before it is dispatched, so `GET /v1/receipts` can answer what happened even when this response is lost. Send your own `idempotencyKey` and a retry replays that outcome instead of touching the phone twice.\n\nA device may refuse a gesture it cannot perform; read its `capabilities` first. A robot arm, for instance, can tap and swipe and cannot type.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","x-phoneuse-modes":["hosted"],"x-phoneuse-credential":"bearer","parameters":["19b036a5-3231-4e45-8990-375eeab783d1"],"requestBody":"b81c1282-5c86-427e-9f40-95c6df39a3b2","security":["6f6273c4-f262-41a3-930d-eef622937b69"],"responses":{"200":"cf7be045-e1fb-4fe4-b2b5-11f936ccfa2a","400":"cd2c0a1b-b7fe-4077-b514-b375c06e0cef","401":"4cf348e3-5b9e-4c70-9375-737e71859ff8","403":"e7b11037-55f5-4752-9f32-dbdbd658e2e3","404":"2e30828e-ddec-400c-a1fc-3b4067e758fe","409":"3e39bd2a-3c6e-4545-9163-5bf241afa879","413":"9bf00b7a-938d-4016-8cc2-4afe70f012ca","429":"62f2a7f8-1369-4ca0-b229-713b71c7f49e","503":"d56ece5f-7980-45db-8662-0d2b806c001d"},"method":"post","type":"path","servers":["0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea"],"path":"/v1/devices/{deviceId}/actions","baseUrlOptions":["{origin}"],"title":"Act on a device","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"19b036a5-3231-4e45-8990-375eeab783d1":{"name":"deviceId","in":"path","required":true,"description":"The device to act on.","schema":{"type":"string","isRequired":true,"description":"The device to act on.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"One gesture.","required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"tap","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","x","y"],"properties":{"action":{"type":"string","const":"tap","isRequired":true,"uniqueKey":"oneOf.0.action","typeLabel":"string"},"x":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.0.x","typeLabel":"number"},"y":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.0.y","typeLabel":"number"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.0.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.0.refuseIfOthersActed","typeLabel":"boolean"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.0.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.0.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"tap · object"},{"type":"object","title":"swipe","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","fromX","fromY","toX","toY"],"properties":{"action":{"type":"string","const":"swipe","isRequired":true,"uniqueKey":"oneOf.1.action","typeLabel":"string"},"fromX":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.1.fromX","typeLabel":"number"},"fromY":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.1.fromY","typeLabel":"number"},"toX":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.1.toX","typeLabel":"number"},"toY":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.1.toY","typeLabel":"number"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.1.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.1.refuseIfOthersActed","typeLabel":"boolean"},"durationMs":{"type":"integer","minimum":1,"maximum":10000,"description":"Gesture duration in milliseconds. Defaults to 300; a value of the wrong type is refused, never read as absent.","uniqueKey":"oneOf.1.durationMs","typeLabel":"integer"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.1.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.1.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"swipe · object"},{"type":"object","title":"long_press","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","x","y"],"properties":{"action":{"type":"string","const":"long_press","isRequired":true,"uniqueKey":"oneOf.2.action","typeLabel":"string"},"x":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.2.x","typeLabel":"number"},"y":{"type":"number","minimum":0,"maximum":1000,"isRequired":true,"uniqueKey":"oneOf.2.y","typeLabel":"number"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.2.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.2.refuseIfOthersActed","typeLabel":"boolean"},"durationMs":{"type":"integer","minimum":200,"maximum":10000,"description":"Hold duration in milliseconds. Defaults to 800; below 200 is a tap, not a hold, and is refused. Dwell time is best effort on a physical device, where the arm prioritises landing accurately over holding for exactly this long.","uniqueKey":"oneOf.2.durationMs","typeLabel":"integer"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.2.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.2.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"long_press · object"},{"type":"object","title":"type_text","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","text"],"properties":{"action":{"type":"string","const":"type_text","isRequired":true,"uniqueKey":"oneOf.3.action","typeLabel":"string"},"text":{"type":"string","description":"Text for the focused input, at most 4096 characters. A device may still refuse characters it cannot inject.","maxLength":4096,"isRequired":true,"uniqueKey":"oneOf.3.text","typeLabel":"string"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.3.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.3.refuseIfOthersActed","typeLabel":"boolean"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.3.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.3.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"type_text · object"},{"type":"object","title":"press_key","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","key"],"properties":{"action":{"type":"string","const":"press_key","isRequired":true,"uniqueKey":"oneOf.4.action","typeLabel":"string"},"key":{"type":"string","enum":["home","back","enter","delete","app_switch","power","volume_up","volume_down"],"description":"The key to press. A device supports a subset; read its capabilities.","isRequired":true,"uniqueKey":"oneOf.4.key","typeLabel":"enum\u003cstring>"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.4.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.4.refuseIfOthersActed","typeLabel":"boolean"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.4.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.4.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.4","typeLabel":"press_key · object"},{"type":"object","title":"open_app","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","appId"],"properties":{"action":{"type":"string","const":"open_app","isRequired":true,"uniqueKey":"oneOf.5.action","typeLabel":"string"},"appId":{"type":"string","description":"OS level app id: an Android package name or an iOS bundle id.","isRequired":true,"uniqueKey":"oneOf.5.appId","typeLabel":"string"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.5.leaseId","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.5.refuseIfOthersActed","typeLabel":"boolean"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.5.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.5.observedFrame","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.5","typeLabel":"open_app · object"},{"type":"object","title":"rotate","description":"One gesture, discriminated by `action`. Coordinates are in the NORMALIZED 0-1000 grid with the origin at the top left of the screen in its current orientation, never in screenshot pixels: the same grid the tools use, so a coordinate read off a UI snapshot can be tapped directly and nothing has to know the device's resolution.\n\n`leaseId` is OPTIONAL for every caller: the gesture runs under the lease your organisation currently holds on the device, whoever inside it took that lease, and when it holds none one is taken for you, provided your credential may take devices (`devices:lease`). A `leaseId` you send is only an address: your organisation holding the device is what authorizes the gesture. Watching a screen needs no lease; moving it still does, and the response tells you which one it ran under.\n\n`refuseIfOthersActed` refuses the gesture if anybody else acted on the device after `observedFrame` was taken. It is on by default for an API key that sends `observedFrame`, off for a person, and off without a frame; send it explicitly to choose.","required":["action","orientation"],"properties":{"action":{"type":"string","const":"rotate","isRequired":true,"uniqueKey":"oneOf.6.action","typeLabel":"string"},"orientation":{"type":"string","enum":["portrait","landscape"],"description":"Requested orientation. Verify fresh screen geometry after the setting commits.","isRequired":true,"uniqueKey":"oneOf.6.orientation","typeLabel":"enum\u003cstring>"},"leaseId":{"type":"string","description":"Optional, for every caller. The gesture runs under the lease your organisation currently holds on this device, or has one taken for it when it holds none (a credential without `devices:lease` is refused `lease_required` instead of taking). A lease id you send is an address, not a credential: your organisation holding the device is what authorizes the gesture, and sending one while your organisation holds nothing is refused `lease_required` rather than turned into a new take.","uniqueKey":"oneOf.6.leaseId","typeLabel":"string"},"idempotencyKey":{"type":"string","description":"Your own id for this one action: 1 to 128 printable ASCII characters, and it must not start with \"agent:\", which is reserved for keys this service issues itself. Send the SAME value when retrying the SAME intended gesture and the recorded outcome is replayed instead of the phone being touched twice. Omit it and the service generates one, which cannot deduplicate your retries.","uniqueKey":"oneOf.6.idempotencyKey","typeLabel":"string"},"observedFrame":{"type":"string","description":"The frame your decision came from. Optional here, unlike on the worker surface: a person driving a live view is looking at the screen as they touch it. When you do send it, the action is refused if that frame is no longer the device's current one, so re-observe and decide again.","uniqueKey":"oneOf.6.observedFrame","typeLabel":"string"},"refuseIfOthersActed":{"type":"boolean","description":"Refuse this gesture (409 `stale_frame`, reason `others_acted`) if another principal acted on the device after `observedFrame` was taken. Sending `true` needs `observedFrame`; without it the body is refused as `invalid_argument`. Left out, it defaults by who is acting: on for an API key, a copilot or a run that sends `observedFrame`, off for a person acting directly, and off whenever no `observedFrame` is sent. You are told through `others` either way.","uniqueKey":"oneOf.6.refuseIfOthersActed","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"oneOf.6","typeLabel":"rotate · object"}],"uniqueKey":"","typeLabel":"tap · object | swipe · object | long_press · object | type_text · object | press_key · object | open_app · object | rotate · object"},"examples":{"Example":{"title":"Example","value":{"action":"tap","x":500,"y":500,"leaseId":"\u003cstring>","refuseIfOthersActed":true,"idempotencyKey":"\u003cstring>","observedFrame":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cf7be045-e1fb-4fe4-b2b5-11f936ccfa2a":{"description":"The device applied it.","content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"type":"string","description":"The device the gesture was applied to.","isRequired":true,"uniqueKey":"deviceId","typeLabel":"string"},"leaseId":{"type":"string","description":"The lease the gesture ran under: the one you named, your organisation's current one, or the one taken for you. Keep it if you want to release a lease this call took for you; nothing else needs it.","isRequired":true,"uniqueKey":"leaseId","typeLabel":"string"},"coDriving":{"type":"boolean","description":"True when the lease belongs to somebody else inside your organisation, an agent's run most often: you acted beside them, and they were informed through their own `others`. False when it is yours.","isRequired":true,"uniqueKey":"coDriving","typeLabel":"boolean"},"status":{"type":"string","const":"committed","description":"The device applied it. There is no other success.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"committedAt":{"type":"string","description":"ISO-8601 instant the device confirmed it, on this service's clock.","isRequired":true,"uniqueKey":"committedAt","typeLabel":"string"},"others":{"type":"object","properties":{"actions":{"type":"integer","description":"How many actions principals other than you took on this device since your anchor. Pending and committed receipts count; failed ones do not.","isRequired":true,"uniqueKey":"others.actions","typeLabel":"integer"},"lastAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the newest of them was requested, on this service's clock. Null when `actions` is 0.","isRequired":true,"uniqueKey":"others.lastAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the newest of them was requested, on this service's clock. Null when `actions` is 0.","isRequired":true,"uniqueKey":"others.lastAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"others.lastAt","typeLabel":"string\u003cdate-time> | null"},"by":{"type":"array","items":{"type":"string","enum":["person","agent"],"description":"Who they were.","uniqueKey":"others.by.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"`person` is a signed-in person acting directly; `agent` is an API key, a copilot, or a run. Each appears at most once, person first.","isRequired":true,"uniqueKey":"others.by","typeLabel":"enum\u003cstring>[]"}},"required":["actions","lastAt","by"],"additionalProperties":false,"description":"What everybody else did on this device since you last looked. On a gesture the anchor is the frame you bound it to, else your previous gesture that reached the device (a refused one never anchors), else the last sixty seconds. A person may drive the same device beside an agent's run; each is informed of the other through this and neither is stopped.","isRequired":true,"uniqueKey":"others","typeLabel":"object"},"idempotencyKey":{"type":"string","description":"The key this action was deduplicated under, whether you sent it or the service generated it.","uniqueKey":"idempotencyKey","typeLabel":"string"},"deduplicated":{"type":"boolean","description":"True when this outcome was replayed from the ledger and the device was NOT touched again. Absent means the gesture really happened just now.","uniqueKey":"deduplicated","typeLabel":"boolean"},"frameNotes":{"type":"object","properties":{"ageMs":{"type":"number","minimum":0,"description":"Milliseconds between the bound frame's capture and the action reaching the arm.","uniqueKey":"frameNotes.ageMs","typeLabel":"number"},"newerFrames":{"type":"integer","minimum":0,"description":"How many frames the arm's camera captured after the bound one.","uniqueKey":"frameNotes.newerFrames","typeLabel":"integer"},"edgeMovedSince":{"type":"boolean","description":"True when the arm moved after the bound frame for a reason that did not come through this API (a calibration or maintenance job). The screen may no longer match what you decided on; look again.","uniqueKey":"frameNotes.edgeMovedSince","typeLabel":"boolean"},"settled":{"type":"boolean","description":"False when the bound frame was taken before the screen had settled after the arm's last move.","uniqueKey":"frameNotes.settled","typeLabel":"boolean"}},"required":[],"additionalProperties":false,"description":"What the robot arm noticed about the frame this action was bound to. The arm no longer refuses an old or overtaken frame: it performs the gesture and reports here, and you decide whether to take a new screenshot before the next one. Present only on a robot-driven phone whose controller reports it, and only on an action that was bound to a frame; any field may be missing.","uniqueKey":"frameNotes","typeLabel":"object"}},"required":["deviceId","leaseId","coDriving","status","committedAt","others"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"deviceId":"\u003cstring>","leaseId":"\u003cstring>","coDriving":true,"status":"committed","committedAt":"\u003cstring>","others":{"actions":123,"lastAt":"2023-11-07T05:31:56Z","by":["person"]},"idempotencyKey":"\u003cstring>","deduplicated":true,"frameNotes":{"ageMs":1,"newerFrames":1,"edgeMovedSince":true,"settled":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"cd2c0a1b-b7fe-4077-b514-b375c06e0cef":{"description":"The body failed validation: not a JSON object, an unknown `action`, a missing or mistyped parameter, a coordinate outside the grid, a duration outside its bounds, or `refuseIfOthersActed` without `observedFrame`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"4cf348e3-5b9e-4c70-9375-737e71859ff8":{"description":"No credential, or one that was refused.","headers":{"WWW-Authenticate":{"description":"A bearer challenge. On a hosted deployment it names the metadata document to discover the authorization server from, and it adds `error=\"invalid_token\"` when a credential was presented and rejected.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"unauthorized","description":"Always `unauthorized` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["missing_credentials","malformed_credentials","invalid_token","token_expired","wrong_audience","missing_org","missing_org_role","unknown_key","revoked_key","expired_key"],"description":"The closed set of ways authentication can fail.","isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"A next step in prose, on the reasons where there is one to give: `revoked_key`, `expired_key`, `missing_org_role`, and `invalid_token` when the account is not a member of the named organization. Absent otherwise, so branch on `reason` and show this if it is there.","uniqueKey":"error.hint","typeLabel":"string"}},"required":["code","reason"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"A refused credential. `unknown_key` covers both a keyId nobody has and a secret that does not match, because telling those apart would enumerate keys for you. Revocation and expiry are distinguishable, since you owned that key.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","reason":"missing_credentials","hint":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7b11037-55f5-4752-9f32-dbdbd658e2e3":{"description":"Acting on a device needs `devices:act`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"2e30828e-ddec-400c-a1fc-3b4067e758fe":{"description":"No such device that this credential can see.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"3e39bd2a-3c6e-4545-9163-5bf241afa879":{"description":"Five refusals, all about the device's state right now rather than about your credential, each with a remedy. `lease_required`: your organisation does not hold the device and this gesture may not take it (you named a lease that is gone, your key lacks `devices:lease`, or the lease ended while the gesture waited its turn); take it and retry. `device_unavailable` with reason `leased`: another organisation holds the device. `stale_frame`: the frame you sent is no longer current, or somebody else acted after it and the refusal was on (reason `others_acted`); look again. `device_busy`: nothing was sent, because too many gestures are already waiting on this device or an earlier action on it (for example an app install) is not finished; retry after `retryAfterMs` (when present) with a new `idempotencyKey`, which is always safe. `action_outcome_unknown`: the gesture was sent and nobody knows whether the screen took it; take a new screenshot before acting again and do not resend it.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"9bf00b7a-938d-4016-8cc2-4afe70f012ca":{"description":"The request body exceeds the server's limit (1 MiB). Refused before the body is parsed, so nothing was partially applied. Retrying the same body will fail the same way: send less. Per-field limits are tighter than this and are documented on the fields themselves; this is the backstop underneath them. The shape is the same on ordinary JSON surfaces, /vrx included. The explicitly configured APK content stream documents its own byte ceiling.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"payload_too_large","description":"Always `payload_too_large` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable summary naming the limit in bytes.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"Returned when the request body exceeds the server limit. Identical on every surface, including /vrx.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"payload_too_large","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"62f2a7f8-1369-4ca0-b229-713b71c7f49e":{"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 `\u003climit>;w=60`.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"rate_limited","description":"Always `rate_limited` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable summary. The numbers are in the headers, not in here.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"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.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d56ece5f-7980-45db-8662-0d2b806c001d":{"description":"Either the authentication backend could not be reached (the service fails closed), or `device_disconnected`: the device dropped off mid-gesture. The body's `retryable` is true for the second; retry once the device is back.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6f6273c4-f262-41a3-930d-eef622937b69":{"bearerAuth":{"type":"http","scheme":"bearer","description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo 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.\n\nBoth 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.\n\nScopes 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.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea":{"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."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo 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.\n\nBoth 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.\n\nScopes 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.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo 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.\n\nBoth 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.\n\nScopes 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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"phonebase","siteName":"PhoneUse","title":"Act on a device - PhoneUse","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T04:26:06.682Z","originalFileLocation":"api/endpoints/devices/act-on-a-device.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device\u0026#x27;s resolution. WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent\u0026#x27;s run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person\u0026#x27;s gesture slides a lease THEY hold when it is running low; it never extends anybody else\u0026#x27;s. DRIVING BESIDE AN AGENT. A person\u0026#x27;s tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person\u0026#x27;s go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture\u0026#x27;s turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel. The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status. Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice. A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Act on a device - PhoneUse\">\u003cmeta data-mint-head property=\"og:description\" content=\"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device\u0026#x27;s resolution. WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent\u0026#x27;s run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person\u0026#x27;s gesture slides a lease THEY hold when it is running low; it never extends anybody else\u0026#x27;s. DRIVING BESIDE AN AGENT. A person\u0026#x27;s tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person\u0026#x27;s go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture\u0026#x27;s turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel. The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status. Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice. A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PhoneUse\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Devices\u0026amp;title=Act+on+a+device\u0026amp;description=One+gesture+per+request%3A+tap%2C+swipe%2C+long+press%2C+type+text%2C+press+a+key%2C+open+an+app.+Coordinates+are+in+the+normalized+0-1000+grid%2C+so+nothing+has+to+know+the+\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=b32fd06c8a0d5ea741a07bf385aeed12dab23b4eaee484dad3001fd7bedfc03a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Act on a device - PhoneUse\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device\u0026#x27;s resolution. WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent\u0026#x27;s run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person\u0026#x27;s gesture slides a lease THEY hold when it is running low; it never extends anybody else\u0026#x27;s. DRIVING BESIDE AN AGENT. A person\u0026#x27;s tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person\u0026#x27;s go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture\u0026#x27;s turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel. The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status. Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice. A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Devices\u0026amp;title=Act+on+a+device\u0026amp;description=One+gesture+per+request%3A+tap%2C+swipe%2C+long+press%2C+type+text%2C+press+a+key%2C+open+an+app.+Coordinates+are+in+the+normalized+0-1000+grid%2C+so+nothing+has+to+know+the+\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=b32fd06c8a0d5ea741a07bf385aeed12dab23b4eaee484dad3001fd7bedfc03a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0c6b4f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoints/devices/act-on-a-device.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phoneuse.com/#organization\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phoneuse.com#website\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device#webpage\",\"url\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device\",\"name\":\"Act on a device\",\"description\":\"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device's resolution. WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent's run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person's gesture slides a lease THEY hold when it is running low; it never extends anybody else's. DRIVING BESIDE AN AGENT. A person's tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person's go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture's turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel. The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status. Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice. A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\",\"dateModified\":\"2026-10-30T04:26:06.682Z\",\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Devices\",\"item\":\"https://docs.phoneuse.com/api/endpoints/devices/small-pictures-of-several-devices-screens\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Act on a device\",\"item\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device#apireference\",\"headline\":\"Act on a device\",\"name\":\"Act on a device\",\"description\":\"One gesture per request: tap, swipe, long press, type text, press a key, open an app. Coordinates are in the normalized 0-1000 grid, so nothing has to know the device's resolution. WHOSE LEASE. Any caller may leave leaseId out. The gesture then runs under the lease your organisation currently holds on the device, whoever inside it took that lease (an agent's run, a colleague, you), and the response says so in coDriving. When your organisation holds none, a lease is taken for you and the gesture runs under it; if that gesture then fails, the lease taken for it is given back before the error is answered, and your next gesture takes one again. Two people taking an idle device at the same moment both drive it: one took the lease, the other is co-driving under it. When another organisation holds the device the answer is the 409 the acquire route gives. Taking needs devices:lease: a key with only devices:act acts on a device its organisation already holds. A signed-in person's gesture slides a lease THEY hold when it is running low; it never extends anybody else's. DRIVING BESIDE AN AGENT. A person's tap does not interrupt a run, and does not wait behind it either: gestures on one device run one at a time, a signed-in person's go ahead of every agent gesture still waiting, and the rest keep their arrival order. The lease is checked again when a gesture's turn comes (one that ended while it waited answers lease_required), each one is receipted with who took it, and every result carries others: what principals other than you did since your anchor. The agent reads the same field on its own results, so it is informed rather than stopped. The only interruptions are explicit and yours: POST /v1/runs/{runId}/pause and POST /v1/runs/{runId}/cancel. The response resolves only once the DEVICE applied the gesture. status has one value, and an action that did not commit is an error rather than a different status. Every attempt is on the receipt ledger before it is dispatched, so GET /v1/receipts can answer what happened even when this response is lost. Send your own idempotencyKey and a retry replays that outcome instead of touching the phone twice. A device may refuse a gesture it cannot perform; read its capabilities first. A robot arm, for instance, can tap and swipe and cannot type. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\",\"url\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/devices/act-on-a-device#webpage\"},\"dateModified\":\"2026-10-30T04:26:06.682Z\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PhoneUse\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PhoneUse\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/endpoints/devices/act-on-a-device.md","siteName":"PhoneUse","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api"},{"title":"Versioning and compatibility","href":"/api/versioning"},{"title":"Rate limits","href":"/api/rate-limits"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Check that the service is up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /healthz","href":"/api/endpoints/health/check-that-the-service-is-up"}]},{"group":"Device surface","pages":[{"title":"Check the run's device channel","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/health","href":"/api/endpoints/device-surface/check-the-runs-device-channel"},{"title":"List the run's device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices","href":"/api/endpoints/device-surface/list-the-runs-device"},{"title":"Fetch a frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices/{deviceId}/screenshot","href":"/api/endpoints/device-surface/fetch-a-frame"},{"title":"Report the run's outcome","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/report","href":"/api/endpoints/device-surface/report-the-runs-outcome"},{"title":"Act on the device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/devices/{deviceId}/actions","href":"/api/endpoints/device-surface/act-on-the-device"}]},{"group":"MCP","pages":[{"title":"Why there is no event stream","deprecated":null,"version":null,"openapi":"/api/openapi.json get /mcp","href":"/api/endpoints/mcp/why-there-is-no-event-stream"},{"title":"Send a JSON-RPC request","deprecated":null,"version":null,"openapi":"/api/openapi.json post /mcp","href":"/api/endpoints/mcp/send-a-json-rpc-request"},{"title":"Why there is no session to end","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /mcp","href":"/api/endpoints/mcp/why-there-is-no-session-to-end"}]},{"group":"Apps","pages":[{"title":"Discover visible devices and authoritative application scopes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/device-capabilities","href":"/api/endpoints/apps/discover-visible-devices-and-authoritative-application-scopes"},{"title":"Read last confirmed phone apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory","href":"/api/endpoints/apps/read-last-confirmed-phone-apps"},{"title":"Request bounded read-only application checks","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-library/inventory/refreshes","href":"/api/endpoints/apps/request-bounded-read-only-application-checks"},{"title":"Read application-check progress","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}","href":"/api/endpoints/apps/read-application-check-progress"},{"title":"Read per-device check outcomes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}/results","href":"/api/endpoints/apps/read-per-device-check-outcomes"},{"title":"Recover a lost mutation response by original key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/requests/{requestKey}","href":"/api/endpoints/apps/recover-a-lost-mutation-response-by-original-key"},{"title":"List installable apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/catalog","href":"/api/endpoints/apps/list-installable-apps"},{"title":"Read installation history","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations","href":"/api/endpoints/apps/read-installation-history"},{"title":"Install an app","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations","href":"/api/endpoints/apps/install-an-app"},{"title":"Recover an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/by-request/{requestKey}","href":"/api/endpoints/apps/recover-an-app-installation"},{"title":"Check an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/{installationId}","href":"/api/endpoints/apps/check-an-app-installation"},{"title":"Check an app installation again","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/recheck","href":"/api/endpoints/apps/check-an-app-installation-again"},{"title":"Skip checking an unconfirmed installation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/skip","href":"/api/endpoints/apps/skip-checking-an-unconfirmed-installation"},{"title":"Read a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue","href":"/api/endpoints/apps/read-a-phones-install-queue"},{"title":"Add an app to a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue","href":"/api/endpoints/apps/add-an-app-to-a-phones-install-queue"},{"title":"Recover a queued app by its request key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue/by-request/{requestKey}","href":"/api/endpoints/apps/recover-a-queued-app-by-its-request-key"},{"title":"Remove a waiting app from a phone's queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/{entryId}/remove","href":"/api/endpoints/apps/remove-a-waiting-app-from-a-phones-queue"},{"title":"Pause or resume a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/pause","href":"/api/endpoints/apps/pause-or-resume-a-phones-install-queue"}]},{"group":"Runs","pages":[{"title":"Get a short-lived URL for one archived frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/frames/{frameId}","href":"/api/endpoints/runs/get-a-short-lived-url-for-one-archived-frame"},{"title":"List your runs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs","href":"/api/endpoints/runs/list-your-runs"},{"title":"Start a run on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs","href":"/api/endpoints/runs/start-a-run-on-a-device"},{"title":"Read a run, optionally waiting for it to move","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs/{runId}","href":"/api/endpoints/runs/read-a-run-optionally-waiting-for-it-to-move"},{"title":"Put a run on hold","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/pause","href":"/api/endpoints/runs/put-a-run-on-hold"},{"title":"Lift a stop and let the run carry on","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/resume","href":"/api/endpoints/runs/lift-a-stop-and-let-the-run-carry-on"},{"title":"Cancel a run","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/cancel","href":"/api/endpoints/runs/cancel-a-run"}]},{"group":"Discovery","pages":[{"title":"Discover where to authenticate","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource","href":"/api/endpoints/discovery/discover-where-to-authenticate"},{"title":"Discover where to authenticate, at the endpoint suffixed path","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource/mcp","href":"/api/endpoints/discovery/discover-where-to-authenticate-at-the-endpoint-suffixed-path"}]},{"group":"API keys","pages":[{"title":"List the org's keys","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys","href":"/api/endpoints/api-keys/list-the-orgs-keys"},{"title":"Mint an API key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys","href":"/api/endpoints/api-keys/mint-an-api-key"},{"title":"Describe the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys/current","href":"/api/endpoints/api-keys/describe-the-calling-key"},{"title":"Revoke the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/current","href":"/api/endpoints/api-keys/revoke-the-calling-key"},{"title":"Revoke a key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/{id}","href":"/api/endpoints/api-keys/revoke-a-key"},{"title":"Rename, renew or narrow a key","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/api-keys/{id}","href":"/api/endpoints/api-keys/rename-renew-or-narrow-a-key"},{"title":"Rotate a key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys/{id}/rotate","href":"/api/endpoints/api-keys/rotate-a-key"},{"title":"Start a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions","href":"/api/endpoints/api-keys/start-a-cli-sign-in"},{"title":"Poll a CLI sign-in, and collect its key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/token","href":"/api/endpoints/api-keys/poll-a-cli-sign-in-and-collect-its-key"},{"title":"Look at a CLI sign-in before approving it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/cli-sessions/{userCode}","href":"/api/endpoints/api-keys/look-at-a-cli-sign-in-before-approving-it"},{"title":"Approve a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/approve","href":"/api/endpoints/api-keys/approve-a-cli-sign-in"},{"title":"Deny a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/deny","href":"/api/endpoints/api-keys/deny-a-cli-sign-in"}]},{"group":"Usage","pages":[{"title":"List your org's receipts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts","href":"/api/endpoints/usage/list-your-orgs-receipts"},{"title":"Read one receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts/{idempotencyKey}","href":"/api/endpoints/usage/read-one-receipt"},{"title":"Mark a receipt reviewed","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/receipts/{idempotencyKey}/reviewed","href":"/api/endpoints/usage/mark-a-receipt-reviewed"},{"title":"List a phone's unclear actions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/unclear-actions","href":"/api/endpoints/usage/list-a-phones-unclear-actions"},{"title":"Confirm a phone looks right","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/unclear-actions/confirm","href":"/api/endpoints/usage/confirm-a-phone-looks-right"},{"title":"Read your org's usage this period","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/usage","href":"/api/endpoints/usage/read-your-orgs-usage-this-period"}]},{"group":"Devices","pages":[{"title":"Small pictures of several devices' screens","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/device-thumbnails","href":"/api/endpoints/devices/small-pictures-of-several-devices-screens"},{"title":"List the devices you can see","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices","href":"/api/endpoints/devices/list-the-devices-you-can-see"},{"title":"Read one device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}","href":"/api/endpoints/devices/read-one-device"},{"title":"Rename a device","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}","href":"/api/endpoints/devices/rename-a-device"},{"title":"Look at a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/screenshot","href":"/api/endpoints/devices/look-at-a-devices-screen"},{"title":"Live video fault observation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/fault","href":"/api/endpoints/devices/live-video-fault-observation"},{"title":"Saved recovery plan cancellation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/cancel","href":"/api/endpoints/devices/saved-recovery-plan-cancellation"},{"title":"Original recovery result recheck","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/recheck","href":"/api/endpoints/devices/original-recovery-result-recheck"},{"title":"Image recovery progress and availability","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/image-maintenance","href":"/api/endpoints/devices/image-recovery-progress-and-availability"},{"title":"Take a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/take-a-device"},{"title":"Give a device back","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/give-a-device-back"},{"title":"Keep a device longer","description":"Extend a lease you already hold, so work longer than one lease can keep its device. The expiry SLIDES to ten minutes from now; it does not add ten minutes to the old one, and `leaseId` and `acquiredAt` do not change, so keep using the same id.\n\nRenew before the lease expires. An expired lease cannot be renewed, because by then the device is available to everyone else and you have to take it again.\n\nWorks on a device that is briefly unreachable, unlike acting on one: losing a claim because the phone blinked would hand it to the next caller while you are still mid task.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/keep-a-device-longer"},{"title":"Act on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/actions","href":"/api/endpoints/devices/act-on-a-device"},{"title":"Who is driving a device","description":"One read for the question a Control view asks after every gesture: is an agent on this device, is a colleague, and whose lease is it under.\n\n`lease` is your organisation's live lease and who inside it holds it, or null; another organisation's lease reads as none, exactly as it does on `GET /v1/leases`. `run` is the run driving the device right now, or null once it has finished. `people` are the people other than you who acted on the device in the last sixty seconds, and `agentLastActionAt` is when an agent last did.\n\nIt joins three things `devices:read` can already read one route at a time, and adds nothing to them: no lease id, no run token, and never a name. A device your organisation does not own, or one outside your key's narrowing, answers 404 exactly as an id that never existed does. An offline device still answers: this route asks who is driving, not whether the phone is reachable.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/driving","href":"/api/endpoints/devices/who-is-driving-a-device"},{"title":"Open a live video session on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/live-session","href":"/api/endpoints/devices/open-a-live-video-session-on-a-device"},{"title":"Wake a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/wake","href":"/api/endpoints/devices/wake-a-devices-screen"},{"title":"Open a live view of a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/stream","href":"/api/endpoints/devices/open-a-live-view-of-a-device"},{"title":"Read the server's clock","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/time","href":"/api/endpoints/devices/read-the-servers-clock"},{"title":"List the devices your organisation currently holds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/leases","href":"/api/endpoints/devices/list-the-devices-your-organisation-currently-holds"}]},{"group":"Copilot","pages":[{"title":"Ask the copilot","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot","href":"/api/endpoints/copilot/ask-the-copilot"},{"title":"Answer a copilot approval","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/approvals","href":"/api/endpoints/copilot/answer-a-copilot-approval"},{"title":"Run one tool the person named","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/commands","href":"/api/endpoints/copilot/run-one-tool-the-person-named"},{"title":"Stop the turn this thread is running","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/threads/{id}/stop","href":"/api/endpoints/copilot/stop-the-turn-this-thread-is-running"},{"title":"Pick a cut copilot stream back up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}/stream","href":"/api/endpoints/copilot/pick-a-cut-copilot-stream-back-up"},{"title":"Your copilot threads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads","href":"/api/endpoints/copilot/your-copilot-threads"},{"title":"One thread, with a page of its messages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/one-thread-with-a-page-of-its-messages"},{"title":"Delete a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/delete-a-thread"},{"title":"Rename a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/rename-a-thread"}]},{"group":"Webhooks","pages":[{"title":"Your webhook subscriptions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks","href":"/api/endpoints/webhooks/your-webhook-subscriptions"},{"title":"Subscribe your system to what happens here","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks","href":"/api/endpoints/webhooks/subscribe-your-system-to-what-happens-here"},{"title":"Remove a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/remove-a-subscription"},{"title":"Enable or disable a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/enable-or-disable-a-subscription"},{"title":"Replace a signing secret","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/rotate","href":"/api/endpoints/webhooks/replace-a-signing-secret"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/test","href":"/api/endpoints/webhooks/send-a-test-delivery"},{"title":"What was delivered, and what happened","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks/{webhookId}/deliveries","href":"/api/endpoints/webhooks/what-was-delivered-and-what-happened"}]},{"group":"Robot purchases","pages":[{"title":"List your robot purchases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases","href":"/api/endpoints/robot-purchases/list-your-robot-purchases"},{"title":"Read the monthly robot checkout offer","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/offer","href":"/api/endpoints/robot-purchases/read-the-monthly-robot-checkout-offer"},{"title":"Open the original monthly robot checkout","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/robot-purchases/checkout","href":"/api/endpoints/robot-purchases/open-the-original-monthly-robot-checkout"},{"title":"Read your initial robot purchase receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/{orderId}","href":"/api/endpoints/robot-purchases/read-your-initial-robot-purchase-receipt"}]},{"group":"Managed Proxy","pages":[{"title":"Quote a multi-unit Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchase-quotes","href":"/api/endpoints/managed-proxy/quote-a-multi-unit-proxy-purchase"},{"title":"Read the original purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchase-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-purchase-agreement"},{"title":"Accept the original multi-unit purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases","href":"/api/endpoints/managed-proxy/accept-the-original-multi-unit-purchase-agreement"},{"title":"Read unit delivery and original payment facts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchases/{purchaseId}","href":"/api/endpoints/managed-proxy/read-unit-delivery-and-original-payment-facts"},{"title":"Cancel original undelivered units","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases/{purchaseId}/cancel","href":"/api/endpoints/managed-proxy/cancel-original-undelivered-units"},{"title":"List managed Proxy products","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products","href":"/api/endpoints/managed-proxy/list-managed-proxy-products"},{"title":"Read a managed Proxy product","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products/{productId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy-product"},{"title":"Quote a managed Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-quotes","href":"/api/endpoints/managed-proxy/quote-a-managed-proxy-purchase"},{"title":"Read the original quote","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-quote"},{"title":"List your Proxy orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders","href":"/api/endpoints/managed-proxy/list-your-proxy-orders"},{"title":"Reserve a quoted Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders","href":"/api/endpoints/managed-proxy/reserve-a-quoted-proxy-order"},{"title":"Read a Proxy order and its settlement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders/{orderId}","href":"/api/endpoints/managed-proxy/read-a-proxy-order-and-its-settlement"},{"title":"Request hosted Checkout for an order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/checkout","href":"/api/endpoints/managed-proxy/request-hosted-checkout-for-an-order"},{"title":"Cancel a Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/cancel","href":"/api/endpoints/managed-proxy/cancel-a-proxy-order"},{"title":"List your managed Proxies","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies","href":"/api/endpoints/managed-proxy/list-your-managed-proxies"},{"title":"Read a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy"},{"title":"Rename a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/rename-a-managed-proxy"},{"title":"Archive an expired detached Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxies/{proxyId}/archive","href":"/api/endpoints/managed-proxy/archive-an-expired-detached-proxy"},{"title":"List your Proxy network operations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations","href":"/api/endpoints/managed-proxy/list-your-proxy-network-operations"},{"title":"Connect or disconnect a Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-operations","href":"/api/endpoints/managed-proxy/connect-or-disconnect-a-proxy"},{"title":"Read a Proxy operation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations/{operationId}","href":"/api/endpoints/managed-proxy/read-a-proxy-operation"},{"title":"Read a device's confirmed Proxy relationship","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/proxy","href":"/api/endpoints/managed-proxy/read-a-devices-confirmed-proxy-relationship"}]},{"group":"Minute billing","pages":[{"title":"/v1/minute/requests/:requestId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/requests/{requestId}","href":"/api/endpoints/minute-billing/v1minuterequests:requestid"},{"title":"/v1/minute/catalog","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/catalog","href":"/api/endpoints/minute-billing/v1minutecatalog"},{"title":"/v1/minute/wallet","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/wallet","href":"/api/endpoints/minute-billing/v1minutewallet"},{"title":"/v1/minute/topup-quotes","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topup-quotes","href":"/api/endpoints/minute-billing/v1minutetopup-quotes"},{"title":"/v1/minute/topups","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups","href":"/api/endpoints/minute-billing/v1minutetopups"},{"title":"/v1/minute/topups/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/topups/{id}","href":"/api/endpoints/minute-billing/v1minutetopups:id"},{"title":"/v1/minute/topups/:id/abandon","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups/{id}/abandon","href":"/api/endpoints/minute-billing/v1minutetopups:idabandon"},{"title":"/v1/minute/starts","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/starts","href":"/api/endpoints/minute-billing/v1minutestarts"},{"title":"/v1/minute/starts/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/starts/{id}","href":"/api/endpoints/minute-billing/v1minutestarts:id"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders-1"},{"title":"/v1/minute/orders/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders/{id}","href":"/api/endpoints/minute-billing/v1minuteorders:id"},{"title":"/v1/minute/orders/:id/cancel","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders/{id}/cancel","href":"/api/endpoints/minute-billing/v1minuteorders:idcancel"},{"title":"/v1/minute/rentals/:deviceId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/rentals/{deviceId}","href":"/api/endpoints/minute-billing/v1minuterentals:deviceid"},{"title":"/v1/minute/rentals/:deviceId/return","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/return","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidreturn"},{"title":"/v1/minute/rentals/:deviceId/resume","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/resume","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidresume"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds-1"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases-1"},{"title":"/v1/minute/cases/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases/{id}","href":"/api/endpoints/minute-billing/v1minutecases:id"},{"title":"/v1/minute/refunds/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds/{id}","href":"/api/endpoints/minute-billing/v1minuterefunds:id"}]},{"group":"Provisioning","pages":[{"title":"Check whether your organisation is provisioned","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/admission","href":"/api/endpoints/provisioning/check-whether-your-organisation-is-provisioned"},{"title":"What your organisation has bought, and where each purchase got to","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments","href":"/api/endpoints/provisioning/what-your-organisation-has-bought-and-where-each-purchase-got-to"},{"title":"Whether one checkout was paid","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/orders/{orderId}/payment-status","href":"/api/endpoints/provisioning/whether-one-checkout-was-paid"},{"title":"Cancelling online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel","href":"/api/endpoints/provisioning/cancelling-online-is-retired:-contact-support"},{"title":"Returning online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/return","href":"/api/endpoints/provisioning/returning-online-is-retired:-contact-support"},{"title":"Stop future Cloud phone renewal at Stripe's current period end","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel-renewal","href":"/api/endpoints/provisioning/stop-future-cloud-phone-renewal-at-stripes-current-period-end"},{"title":"Read a Cloud phone's current monthly renewal state","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments/{id}/renewal-status","href":"/api/endpoints/provisioning/read-a-cloud-phones-current-monthly-renewal-state"},{"title":"What you owe next","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/billing/upcoming","href":"/api/endpoints/provisioning/what-you-owe-next"},{"title":"Open the billing portal","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/billing/portal-sessions","href":"/api/endpoints/provisioning/open-the-billing-portal"},{"title":"List what can be bought and what it costs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/skus","href":"/api/endpoints/provisioning/list-what-can-be-bought-and-what-it-costs"},{"title":"Start provisioning this organisation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions","href":"/api/endpoints/provisioning/start-provisioning-this-organisation"},{"title":"Check one returned Checkout now","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions/{orderId}/confirm","href":"/api/endpoints/provisioning/check-one-returned-checkout-now"},{"title":"Where the payment provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/stripe","href":"/api/endpoints/provisioning/where-the-payment-provider-delivers"},{"title":"Where the identity provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/clerk","href":"/api/endpoints/provisioning/where-the-identity-provider-delivers"}]},{"group":"Notifications","pages":[{"title":"The bell, and the list behind it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/notifications","href":"/api/endpoints/notifications/the-bell-and-the-list-behind-it"},{"title":"Mark notifications read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/notifications/read","href":"/api/endpoints/notifications/mark-notifications-read"},{"title":"Which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/me/notification-preferences","href":"/api/endpoints/notifications/which-emails-you-receive"},{"title":"Change which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/me/notification-preferences","href":"/api/endpoints/notifications/change-which-emails-you-receive"}]}]}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/overview"}]}]},"basePath":"","title":"Act on a device - PhoneUse","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}