Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console’s composer becomes.
It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf.
WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of “tap the login button” is a sentence and the coordinates are the copilot’s job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing.
WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device’s page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400.
IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn’s copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation.
IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another.
Needs a signed in person, as every copilot route does.
Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.
POST
/
v1
/
copilot
/
commands
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.
Body
application/json
The command.
tool
string
required
The tool name, as the MCP reference spells it.
input
object
The tool's arguments, in its own published input schema.
context
CopilotContext · object
What the console knows and the sentence does not say. Every device id here must be one your session can address, or the request is 400 naming the field. Resolution order for which phone a turn is about: pinned, then mentions, then context.device, then the device this thread last acted on, then the only device you have, then a data-device-choice card. THIS BLOCK IS NOT REPLAYED: it describes where somebody is now, so it is read from this request only and never from the stored thread.
Show child attributes
mentions
string[]
Device ids the person named with an @ in this message. The id travels, never the typed name, so renaming a phone cannot re-point a message. Exactly one names the turn's device; two or more raise the chooser.
Maximum array length: 10
threadId
string
Append the result to this thread, as a tool part. Required for a command that asks first.
Pattern: ^[A-Za-z0-9_-]{1,128}$
approvalId
string
The id from a 202 this route returned, sent with the same tool and input to run it.
instructionMode
enum<string>
Optional mode for this direct instruction only. Does not persist the thread choice. Must be omitted when approvalId is supplied.
Available options:
auto,
ask,
manual
Response
The tool ran. isError is the tool's own verdict, not an HTTP status: a refusal by the device is a 200 with isError true.
tool
string
required
The tool that ran.
isError
boolean
required
The tool's own verdict.
output
CopilotCommandOutput · object
required
Show child attributes
files
object[]
Pictures the tool returned, as data: URLs, when small enough to carry inline.
Show child attributes
threadId
string
The thread the result was appended to, when one was named.
messageId
string
The assistant message the result was written as.
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/copilot/run-one-tool-the-person-named","slug":"/api/endpoints/copilot/run-one-tool-the-person-named","pageMetadata":{"title":"Run one tool the person named","description":"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a `/screenshot` or a `/press_key home` typed in the console's composer becomes.\n\nIt reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled `via copilot`: you did this, not the copilot on your behalf.\n\nWHAT IS DIRECT. Every read, plus `open_app`, `press_key`, `release_device`, `list_runs`, `cancel_run` and `resume_run`: the tools whose arguments a person can write out in full. `tap`, `swipe`, `type_text` and `long_press` are NOT, because the useful form of \"tap the login button\" is a sentence and the coordinates are the copilot's job; nor is `start_run`, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing.\n\nWHICH PHONE. `context` and `mentions` work exactly as they do on `POST /v1/copilot`, so a command typed on a device's page needs no `deviceId`. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400.\n\nIN A CONVERSATION. Send `threadId` and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn's copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation.\n\nIF IT ASKS FIRST. `start_run` raises a card in a command exactly as it does in the chat: the answer is 202 with an `approval` descriptor and an `approvalId`, and nothing has run. Show the card, then send the SAME `tool` and `input` again with that `approvalId`. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a `threadId` to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another.\n\nNeeds a signed in person, as every copilot route does.\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/copilot/commands","href":"/api/endpoints/copilot/run-one-tool-the-person-named","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: [_jsxs(_components.p, {\n children: [\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a \", _jsx(_components.code, {\n children: \"/screenshot\"\n }), \" or a \", _jsx(_components.code, {\n children: \"/press_key home\"\n }), \" typed in the console’s composer becomes.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled \", _jsx(_components.code, {\n children: \"via copilot\"\n }), \": you did this, not the copilot on your behalf.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"WHAT IS DIRECT. Every read, plus \", _jsx(_components.code, {\n children: \"open_app\"\n }), \", \", _jsx(_components.code, {\n children: \"press_key\"\n }), \", \", _jsx(_components.code, {\n children: \"release_device\"\n }), \", \", _jsx(_components.code, {\n children: \"list_runs\"\n }), \", \", _jsx(_components.code, {\n children: \"cancel_run\"\n }), \" and \", _jsx(_components.code, {\n children: \"resume_run\"\n }), \": the tools whose arguments a person can write out in full. \", _jsx(_components.code, {\n children: \"tap\"\n }), \", \", _jsx(_components.code, {\n children: \"swipe\"\n }), \", \", _jsx(_components.code, {\n children: \"type_text\"\n }), \" and \", _jsx(_components.code, {\n children: \"long_press\"\n }), \" are NOT, because the useful form of “tap the login button” is a sentence and the coordinates are the copilot’s job; nor is \", _jsx(_components.code, {\n children: \"start_run\"\n }), \", which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"WHICH PHONE. \", _jsx(_components.code, {\n children: \"context\"\n }), \" and \", _jsx(_components.code, {\n children: \"mentions\"\n }), \" work exactly as they do on \", _jsx(_components.code, {\n children: \"POST /v1/copilot\"\n }), \", so a command typed on a device’s page needs no \", _jsx(_components.code, {\n children: \"deviceId\"\n }), \". A tool that needs one, with nothing in the input and nothing the context could resolve, is 400.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"IN A CONVERSATION. Send \", _jsx(_components.code, {\n children: \"threadId\"\n }), \" and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn’s copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"IF IT ASKS FIRST. \", _jsx(_components.code, {\n children: \"start_run\"\n }), \" raises a card in a command exactly as it does in the chat: the answer is 202 with an \", _jsx(_components.code, {\n children: \"approval\"\n }), \" descriptor and an \", _jsx(_components.code, {\n children: \"approvalId\"\n }), \", and nothing has run. Show the card, then send the SAME \", _jsx(_components.code, {\n children: \"tool\"\n }), \" and \", _jsx(_components.code, {\n children: \"input\"\n }), \" again with that \", _jsx(_components.code, {\n children: \"approvalId\"\n }), \". The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a \", _jsx(_components.code, {\n children: \"threadId\"\n }), \" to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Needs a signed in person, as every copilot route does.\"\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":"Run one tool the person named","description":"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a `/screenshot` or a `/press_key home` typed in the console's composer becomes.\n\nIt reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled `via copilot`: you did this, not the copilot on your behalf.\n\nWHAT IS DIRECT. Every read, plus `open_app`, `press_key`, `release_device`, `list_runs`, `cancel_run` and `resume_run`: the tools whose arguments a person can write out in full. `tap`, `swipe`, `type_text` and `long_press` are NOT, because the useful form of \"tap the login button\" is a sentence and the coordinates are the copilot's job; nor is `start_run`, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing.\n\nWHICH PHONE. `context` and `mentions` work exactly as they do on `POST /v1/copilot`, so a command typed on a device's page needs no `deviceId`. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400.\n\nIN A CONVERSATION. Send `threadId` and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn's copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation.\n\nIF IT ASKS FIRST. `start_run` raises a card in a command exactly as it does in the chat: the answer is 202 with an `approval` descriptor and an `approvalId`, and nothing has run. Show the card, then send the SAME `tool` and `input` again with that `approvalId`. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a `threadId` to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another.\n\nNeeds a signed in person, as every copilot route does.\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/copilot/commands","href":"/api/endpoints/copilot/run-one-tool-the-person-named","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postV1CopilotCommands","tags":["Copilot"],"summary":"Run one tool the person named","description":"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a `/screenshot` or a `/press_key home` typed in the console's composer becomes.\n\nIt reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled `via copilot`: you did this, not the copilot on your behalf.\n\nWHAT IS DIRECT. Every read, plus `open_app`, `press_key`, `release_device`, `list_runs`, `cancel_run` and `resume_run`: the tools whose arguments a person can write out in full. `tap`, `swipe`, `type_text` and `long_press` are NOT, because the useful form of \"tap the login button\" is a sentence and the coordinates are the copilot's job; nor is `start_run`, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing.\n\nWHICH PHONE. `context` and `mentions` work exactly as they do on `POST /v1/copilot`, so a command typed on a device's page needs no `deviceId`. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400.\n\nIN A CONVERSATION. Send `threadId` and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn's copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation.\n\nIF IT ASKS FIRST. `start_run` raises a card in a command exactly as it does in the chat: the answer is 202 with an `approval` descriptor and an `approvalId`, and nothing has run. Show the card, then send the SAME `tool` and `input` again with that `approvalId`. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a `threadId` to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another.\n\nNeeds a signed in person, as every copilot route does.\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","requestBody":"5a9e9928-6978-41da-b879-0c40e67cf84a","security":["c507959f-5c47-4eda-bcef-fa5e1b523768"],"responses":{"200":"b6136188-f7ab-4e7d-b7f9-78859cfcd399","202":"a61a8a3d-bb72-44e0-86c1-30c89fa09c0f","400":"8eda8fa5-189c-4e1b-8835-5d2bad291344","401":"d1774627-9f77-4d0f-b370-d5c217093d06","403":"caaf6c8b-a45d-49a2-b7ba-a64a79e0c939","404":"b8945662-40b6-48c0-9a5d-fbd95593b28f","413":"92b2991a-043b-456d-b546-6a1e3dc1b33b","429":"8fcf4081-5dbc-4b0f-b333-78e9b65a91c3","503":"ccbcb54b-71a7-4ffc-a1ff-ba80fd4b105e"},"method":"post","type":"path","servers":["0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea"],"path":"/v1/copilot/commands","baseUrlOptions":["{origin}"],"title":"Run one tool the person named","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"The command.","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tool":{"type":"string","description":"The tool name, as the MCP reference spells it.","isRequired":true,"uniqueKey":"tool","typeLabel":"string"},"input":{"type":"object","additionalProperties":true,"description":"The tool's arguments, in its own published input schema.","uniqueKey":"input","typeLabel":"object"},"context":{"type":"object","properties":{"route":{"type":"string","description":"The console route being viewed, e.g. `/devices/pixel-1`. Orientation for the model; never parsed for ids.","maxLength":200,"uniqueKey":"context.route","typeLabel":"string"},"device":{"type":"object","properties":{"id":{"type":"string","description":"The device that page is about.","isRequired":true,"uniqueKey":"context.device.id","typeLabel":"string"}},"required":["id"],"additionalProperties":true,"uniqueKey":"context.device","typeLabel":"object"},"run":{"type":"object","properties":{"id":{"type":"string","description":"The agent run that page is about.","isRequired":true,"uniqueKey":"context.run.id","typeLabel":"string"}},"required":["id"],"additionalProperties":true,"uniqueKey":"context.run","typeLabel":"object"},"selection":{"type":"object","properties":{"deviceIds":{"type":"array","items":{"type":"string","uniqueKey":"context.selection.deviceIds.items.[INDEX]","typeLabel":"string"},"description":"Devices ticked on a list page. More than one always asks which comes first.","isRequired":true,"uniqueKey":"context.selection.deviceIds","typeLabel":"string[]"}},"required":["deviceIds"],"additionalProperties":true,"uniqueKey":"context.selection","typeLabel":"object"},"pinned":{"type":"object","properties":{"deviceId":{"type":"string","description":"A device pinned to this thread. Outranks every other source.","isRequired":true,"uniqueKey":"context.pinned.deviceId","typeLabel":"string"}},"required":["deviceId"],"additionalProperties":true,"uniqueKey":"context.pinned","typeLabel":"object"}},"required":[],"additionalProperties":true,"title":"CopilotContext","description":"What the console knows and the sentence does not say. Every device id here must be one your session can address, or the request is 400 naming the field. Resolution order for which phone a turn is about: `pinned`, then `mentions`, then `context.device`, then the device this thread last acted on, then the only device you have, then a `data-device-choice` card. THIS BLOCK IS NOT REPLAYED: it describes where somebody is now, so it is read from this request only and never from the stored thread.","uniqueKey":"context","typeLabel":"CopilotContext · object"},"mentions":{"type":"array","maxItems":10,"items":{"type":"string","uniqueKey":"mentions.items.[INDEX]","typeLabel":"string"},"description":"Device ids the person named with an `@` in this message. The id travels, never the typed name, so renaming a phone cannot re-point a message. Exactly one names the turn's device; two or more raise the chooser.","uniqueKey":"mentions","typeLabel":"string[]"},"threadId":{"type":"string","description":"Append the result to this thread, as a tool part. Required for a command that asks first.","pattern":"^[A-Za-z0-9_-]{1,128}$","uniqueKey":"threadId","typeLabel":"string"},"approvalId":{"type":"string","description":"The id from a 202 this route returned, sent with the same tool and input to run it.","uniqueKey":"approvalId","typeLabel":"string"},"instructionMode":{"type":"string","enum":["auto","ask","manual"],"description":"Optional mode for this direct instruction only. Does not persist the thread choice. Must be omitted when approvalId is supplied.","uniqueKey":"instructionMode","typeLabel":"enum\u003cstring>"}},"required":["tool"],"additionalProperties":false,"title":"CopilotCommandBody","uniqueKey":"","typeLabel":"CopilotCommandBody · object"},"examples":{"Example":{"title":"Example","value":{"tool":"\u003cstring>","input":{},"context":{"route":"\u003cstring>"},"mentions":["\u003cstring>"],"threadId":"\u003cstring>","approvalId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b6136188-f7ab-4e7d-b7f9-78859cfcd399":{"description":"The tool ran. `isError` is the tool's own verdict, not an HTTP status: a refusal by the device is a 200 with `isError` true.","content":{"application/json":{"schema":{"type":"object","properties":{"tool":{"type":"string","description":"The tool that ran.","isRequired":true,"uniqueKey":"tool","typeLabel":"string"},"isError":{"type":"boolean","description":"The tool's own verdict.","isRequired":true,"uniqueKey":"isError","typeLabel":"boolean"},"output":{"type":"object","properties":{"summary":{"type":"string","description":"A bounded line, as a chat bubble shows it.","isRequired":true,"uniqueKey":"output.summary","typeLabel":"string"},"text":{"type":"string","description":"The tool's whole answer.","isRequired":true,"uniqueKey":"output.text","typeLabel":"string"},"frameId":{"type":"string","description":"The frame a screenshot produced, when it named one.","uniqueKey":"output.frameId","typeLabel":"string"}},"required":["summary","text"],"additionalProperties":false,"title":"CopilotCommandOutput","isRequired":true,"uniqueKey":"output","typeLabel":"CopilotCommandOutput · object"},"files":{"type":"array","description":"Pictures the tool returned, as `data:` URLs, when small enough to carry inline.","items":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type.","isRequired":true,"uniqueKey":"files.items.[INDEX].mediaType","typeLabel":"string"},"url":{"type":"string","description":"A `data:` URL.","isRequired":true,"uniqueKey":"files.items.[INDEX].url","typeLabel":"string"}},"required":["mediaType","url"],"additionalProperties":false,"uniqueKey":"files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"files","typeLabel":"object[]"},"threadId":{"type":"string","description":"The thread the result was appended to, when one was named.","uniqueKey":"threadId","typeLabel":"string"},"messageId":{"type":"string","description":"The assistant message the result was written as.","uniqueKey":"messageId","typeLabel":"string"}},"required":["tool","isError","output"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"tool":"\u003cstring>","isError":true,"output":{"summary":"\u003cstring>","text":"\u003cstring>","frameId":"\u003cstring>"},"files":[{"mediaType":"\u003cstring>","url":"\u003cstring>"}],"threadId":"\u003cstring>","messageId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a61a8a3d-bb72-44e0-86c1-30c89fa09c0f":{"description":"It asks first. Nothing ran. Show the card, then send the same tool and input again with the `approvalId`.","content":{"application/json":{"schema":{"type":"object","properties":{"approval":{"type":"object","properties":{"tool":{"type":"string","description":"The tool the question is about.","isRequired":true,"uniqueKey":"approval.tool","typeLabel":"string"},"arguments":{"type":"object","additionalProperties":true,"description":"The arguments it would run with.","isRequired":true,"uniqueKey":"approval.arguments","typeLabel":"object"},"prompt":{"type":"string","description":"One sentence naming the effect, built from the tool and its arguments and never from model prose.","isRequired":true,"uniqueKey":"approval.prompt","typeLabel":"string"}},"required":["tool","arguments","prompt"],"additionalProperties":false,"title":"CopilotCommandApproval","isRequired":true,"uniqueKey":"approval","typeLabel":"CopilotCommandApproval · object"},"approvalId":{"type":"string","description":"Send this back with the same tool and input.","isRequired":true,"uniqueKey":"approvalId","typeLabel":"string"},"toolCallId":{"type":"string","description":"The call the question is about, as the thread stores it.","isRequired":true,"uniqueKey":"toolCallId","typeLabel":"string"}},"required":["approval","approvalId","toolCallId"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"approval":{"tool":"\u003cstring>","arguments":{},"prompt":"\u003cstring>"},"approvalId":"\u003cstring>","toolCallId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8eda8fa5-189c-4e1b-8835-5d2bad291344":{"description":"An unknown tool, a tool that is not a direct command (ask in the conversation), a context naming a device you cannot address, a tool that needs a device when nothing named one, or a gated command with no `threadId` to hold its card.","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"},"d1774627-9f77-4d0f-b370-d5c217093d06":{"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"},"caaf6c8b-a45d-49a2-b7ba-a64a79e0c939":{"description":"An API key, or a tool your session has no scope for. The message names the scope.","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"},"b8945662-40b6-48c0-9a5d-fbd95593b28f":{"description":"The thread is not yours, or no question is waiting on that `approvalId` for this command.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"not_found","description":"Always `not_found` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable summary naming the kind of thing that was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"No such thing that you may act on. Not an existence oracle over other organisations' ids.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"92b2991a-043b-456d-b546-6a1e3dc1b33b":{"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"},"8fcf4081-5dbc-4b0f-b333-78e9b65a91c3":{"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"},"ccbcb54b-71a7-4ffc-a1ff-ba80fd4b105e":{"description":"This deployment serves no direct commands.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"service_unavailable","description":"Always `service_unavailable` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable summary naming the surface this deployment does not serve.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"This deployment does not serve that surface. No `Retry-After`: waiting does not help.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"service_unavailable","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c507959f-5c47-4eda-bcef-fa5e1b523768":{"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":"Run one tool the person named - PhoneUse","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T04:26:06.578Z","originalFileLocation":"api/endpoints/copilot/run-one-tool-the-person-named.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=\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console\u0026#x27;s composer becomes. It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf. WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of \u0026quot;tap the login button\u0026quot; is a sentence and the coordinates are the copilot\u0026#x27;s job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing. WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device\u0026#x27;s page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400. IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn\u0026#x27;s copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation. IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another. Needs a signed in person, as every copilot route does. 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=\"Run one tool the person named - PhoneUse\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console\u0026#x27;s composer becomes. It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf. WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of \u0026quot;tap the login button\u0026quot; is a sentence and the coordinates are the copilot\u0026#x27;s job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing. WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device\u0026#x27;s page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400. IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn\u0026#x27;s copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation. IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another. Needs a signed in person, as every copilot route does. 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/copilot/run-one-tool-the-person-named\">\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=Copilot\u0026amp;title=Run+one+tool+the+person+named\u0026amp;description=Run+ONE+tool+directly%2C+as+yourself%2C+with+no+model+involved+and+no+tokens+spent.+This+is+what+a+%60%2Fscreenshot%60+or+a+%60%2Fpress_key+home%60+typed+in+the+console%27s+compo\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=62cdf674550af4a952b2cb5eb6afc256935a9f723960d9ad5f5a4a0f9a418820\">\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=\"Run one tool the person named - PhoneUse\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console\u0026#x27;s composer becomes. It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf. WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of \u0026quot;tap the login button\u0026quot; is a sentence and the coordinates are the copilot\u0026#x27;s job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing. WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device\u0026#x27;s page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400. IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn\u0026#x27;s copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation. IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another. Needs a signed in person, as every copilot route does. 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=Copilot\u0026amp;title=Run+one+tool+the+person+named\u0026amp;description=Run+ONE+tool+directly%2C+as+yourself%2C+with+no+model+involved+and+no+tokens+spent.+This+is+what+a+%60%2Fscreenshot%60+or+a+%60%2Fpress_key+home%60+typed+in+the+console%27s+compo\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=62cdf674550af4a952b2cb5eb6afc256935a9f723960d9ad5f5a4a0f9a418820\">\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/copilot/run-one-tool-the-person-named\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoints/copilot/run-one-tool-the-person-named.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/copilot/run-one-tool-the-person-named#webpage\",\"url\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named\",\"name\":\"Run one tool the person named\",\"description\":\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console's composer becomes. It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf. WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of \\\"tap the login button\\\" is a sentence and the coordinates are the copilot's job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing. WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device's page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400. IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn's copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation. IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another. Needs a signed in person, as every copilot route does. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\",\"dateModified\":\"2026-10-30T04:26:06.578Z\",\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named#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\":\"Copilot\",\"item\":\"https://docs.phoneuse.com/api/endpoints/copilot/ask-the-copilot\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Run one tool the person named\",\"item\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named#apireference\",\"headline\":\"Run one tool the person named\",\"name\":\"Run one tool the person named\",\"description\":\"Run ONE tool directly, as yourself, with no model involved and no tokens spent. This is what a /screenshot or a /press_key home typed in the console's composer becomes. It reaches the SAME tool surface a copilot turn drives, under the same permissions and the same approval table, so a command cannot do what the conversation would refuse. Two things differ from a turn, and both follow from the person having typed the tool themselves. It works on a deployment with NO copilot configured, because pressing Home should not need a model. And the receipt is not labelled via copilot: you did this, not the copilot on your behalf. WHAT IS DIRECT. Every read, plus open_app, press_key, release_device, list_runs, cancel_run and resume_run: the tools whose arguments a person can write out in full. tap, swipe, type_text and long_press are NOT, because the useful form of \\\"tap the login button\\\" is a sentence and the coordinates are the copilot's job; nor is start_run, which takes a goal and a budget. Those answer 400 and say to ask in the conversation instead. A tool your session has no scope for is a different answer: 403, naming the scope, because the remedy is an administrator rather than a rephrasing. WHICH PHONE. context and mentions work exactly as they do on POST /v1/copilot, so a command typed on a device's page needs no deviceId. A tool that needs one, with nothing in the input and nothing the context could resolve, is 400. IN A CONVERSATION. Send threadId and the result is appended to that thread as a tool part, which is what makes a command followed by a sentence work: the next turn's copilot sees what the command did instead of a gap. Without it the command still runs and leaves no trace in any conversation. IF IT ASKS FIRST. start_run raises a card in a command exactly as it does in the chat: the answer is 202 with an approval descriptor and an approvalId, and nothing has run. Show the card, then send the SAME tool and input again with that approvalId. The question is stored on the thread, so it can be answered minutes later and on any machine, and a gated command therefore needs a threadId to put its card in. The tool and arguments are checked against what was asked: a yes to one command cannot be spent on another. Needs a signed in person, as every copilot route does. 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/copilot/run-one-tool-the-person-named\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/copilot/run-one-tool-the-person-named#webpage\"},\"dateModified\":\"2026-10-30T04:26:06.578Z\",\"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/copilot/run-one-tool-the-person-named.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","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","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","description":"Answer one `approval.request` from an open copilot stream.\n\nIt returns as soon as the answer is recorded and tells you nothing about what happened next, because what happens next appears on the STREAM: `tool.call` then `tool.result` for an allow, `tool.denied` for a deny. A client waiting on this response to render the outcome is waiting for the wrong thing.\n\nOnly the person the question was asked of may answer it, on the same organisation. An id that names nothing, one already answered, one that expired and one belonging to somebody else all answer 404 alike: telling them apart would make this a way to probe other people's outstanding questions.\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/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","description":"Stop the copilot mid-turn. The loop stops before its next model step or tool call, and what it had written is stored like any other ending, so the thread reads as a turn that stopped rather than one that vanished.\n\nA stop does not undo anything: a tool already dispatched has finished and its receipt stands.\n\n`stopped` is false when nothing was running this thread, including after the service restarted, which ends any turn it was running. That is an answer, not an error: there is nothing left to stop.\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/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":"Run one tool the person named - 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"]}