{
"error": {
"type": "rate_limited",
"message": "This API key exceeded its request-rate limit"
}
}
Devices
Read your Device
Returns a device and its approved roots. Default scope exposes only the caller’s devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found.
{
"error": {
"type": "rate_limited",
"message": "This API key exceeded its request-rate limit"
}
}
Authorizations
Authorization
string
header
required
Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).
Scopes
devices:read
Path Parameters
orgId
string
required
Organization id or slug. Resolve it with GET /v3/self.
deviceId
string<uuid>
required
The owned Device id, returned as id by listDevices.
Query Parameters
scope
enum<string>
default:owned
Whose Devices to search: the caller's own, or every member's Device in the workspace, which only owners and admins may read.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Reason Documentation","description":"Guides to Reason, Reason Network, the HTTP API, and MCP.","colors":{"primary":"#0d0d0d","light":"#ededed","dark":"#0d0d0d"},"logo":{"light":"https://reasonmachines.com/reason-logo/reason-logo-black-transparent-512.png","dark":"https://reasonmachines.com/reason-logo/reason-logo-white-transparent-512.png","href":"/"},"favicon":"https://reasonmachines.com/favicon-512.png","api":{"playground":{"display":"simple"}},"navbar":{"primary":{"type":"button","label":"Try Reason","href":"https://reasonmachines.com/login?signin=1"}},"seo":{"metatags":{"canonical":"https://docs.reasonmachines.com"}},"integrations":{"posthog":{"apiKey":"phc_eYpkukex3YcO0dK2UtBLdXAkzPOga8mOucwH7gqv2f","apiHost":"https://us.i.posthog.com","sessionRecording":true}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ara-90a60a07","hasAudioNarration":false,"actualSubdomain":"ara-90a60a07","customDomains":[],"gitSource":{"type":"github","owner":"reason-machines","repo":"docs.reasonmachines.com","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc385d8d9b01397d3acbfe","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":319},{"language":"default","tag":"Endpoints","count":318},{"language":"default","tag":"Sessions","count":44},{"language":"default","tag":"Agent network","count":24},{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"Devices","count":21},{"language":"default","tag":"Checkpoint artifacts","count":16},{"language":"default","tag":"Automations","count":15},{"language":"default","tag":"Provider credentials","count":15},{"language":"default","tag":"Reasons","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--background-light: 255 255 255;--background-dark: 24 24 24;--doc-section-light: 115 115 115;--doc-section-dark: 163 163 163}html,body{background-color:rgb(var(--background-light))!important}#sidebar{background-color:rgb(var(--background-light))!important}html.dark,html.dark body{background-color:rgb(var(--background-dark))!important}html.dark #sidebar{background-color:rgb(var(--background-dark))!important}#sidebar .sidebar-group-header{color:rgb(var(--doc-section-light))!important;font-size:0.6875rem!important;font-weight:600!important;letter-spacing:0.08em;line-height:1.2!important;text-transform:uppercase}html.dark #sidebar .sidebar-group-header{color:rgb(var(--doc-section-dark))!important}#navbar a.select-none{display:inline-flex;align-items:center;gap:0.625rem}#navbar a.select-none::after{content:\"Reason Docs\";color:inherit;font-size:1.125rem;font-weight:500;letter-spacing:-0.025em;line-height:1;white-space:nowrap}#footer{display:none!important}#pagination{margin-bottom:2.5rem!important}@media (min-width: 1024px){:root{--topbar-tabs-height: 0rem !important}#navbar .hidden.lg\\:flex.px-12.h-12{height:0;padding:0;overflow:visible}#navbar .nav-tabs{position:absolute;top:0.5rem;left:50%;z-index:30;height:3rem;transform:translateX(-50%);align-items:center;gap:0.25rem;padding:0.25rem;border-radius:9999px}#navbar .nav-tabs-item{height:2.5rem;padding:0 1rem;border-radius:9999px;color:rgb(82 82 82)}#navbar .nav-tabs-item>div{display:none}#navbar .nav-tabs-item[data-active]{color:rgb(20 20 20);background:rgb(245 245 244)}html.dark #navbar .nav-tabs-item{color:rgb(212 212 212)}html.dark #navbar .nav-tabs-item[data-active]{color:rgb(250 250 249);background:rgb(255 255 255 / 0.12)}#navbar #search-bar-entry,#navbar #assistant-entry,#navbar #topbar-cta-button>a,#navbar #topbar-cta-button>a>span{border-radius:9999px}#navbar #assistant-entry{width:2.25rem;padding:0}#navbar #assistant-entry>span{display:none}#navbar #search-bar-entry>span{display:none}#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20.gap-2\\.5,#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20,#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20.justify-center{flex:0 0 auto;margin-left:auto;order:2}#navbar #search-bar-entry{width:clamp(7.5rem, 10vw, 11rem)}#navbar .flex-1.relative.hidden.lg\\:flex.items-center.ml-auto.justify-end.space-x-4{flex:0 0 auto;order:3;margin-left:0.75rem}}@media (min-width: 1024px) and (max-width: 1439px){#navbar #assistant-entry{display:none!important}#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20.gap-2\\.5,#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20,#navbar .h-full.relative.flex-1.flex.items-center.gap-x-4.min-w-0>.relative.hidden.lg\\:flex.items-center.flex-1.z-20.justify-center{margin-left:auto}}.dark #navigation-items .sidebar-group a[aria-current=\"page\"]{color:rgb(250 250 249);background-color:rgb(245 245 244 / 0.16)}.dark #navigation-items .sidebar-group a:not([aria-current=\"page\"]){color:rgb(212 212 212)}.dark #navigation-items .sidebar-group a:not([aria-current=\"page\"]):hover{color:rgb(250 250 249);background-color:rgb(245 245 244 / 0.1)}.code-block,.code-block [data-component-part=\"code-block-root\"],.code-block pre.shiki{background:transparent!important}html .code-block .code-block-background{background-color:transparent!important}html.light .code-block pre.shiki code,html.light .code-block pre.shiki .line{color:rgb(31 35 40)!important}.code-block [data-floating-buttons=\"true\"] button,.code-block [data-floating-buttons=\"true\"] button svg{opacity:1!important;visibility:visible!important}.code-block [data-floating-buttons=\"true\"] button svg{color:currentColor!important}html:not(.dark) .code-block code,html:not(.dark) .codeblock-light code,html:not(.dark) pre.shiki code{color:rgb(31 35 40)!important}html.dark .code-block code,html.dark .codeblock-dark code,html.dark pre.shiki code{color:rgb(230 237 243)!important}html.dark pre.shiki:not(.code-block pre){background-color:var(--shiki-dark-bg)!important}.copy-prompt-button{--spread: 90deg;--shimmer-color: #fff;--speed: 3s;--cut: 0.05em;--copy-prompt-bg: rgb(var(--primary));position:relative;display:inline-flex;align-items:center;justify-content:center;gap:0.5rem;height:2.25rem;padding:0 1rem;overflow:hidden;isolation:isolate;border:1px solid rgb(255 255 255 / 0.1);border-radius:0.5rem;background-color:var(--copy-prompt-bg);color:rgb(255 255 255);font-size:0.875rem;line-height:1.25rem;font-weight:500;white-space:nowrap;cursor:pointer}.copy-prompt-button:hover{--copy-prompt-bg: rgb(var(--primary-dark))}.copy-prompt-button svg,.copy-prompt-label{position:relative;z-index:1}.copy-prompt-button svg{width:1rem;height:1rem;flex-shrink:0}.copy-prompt-spark{position:absolute;inset:0;z-index:-30;overflow:hidden;filter:blur(2px);container-type:size;pointer-events:none}.copy-prompt-spark-track{position:absolute;inset:0;height:100cqh;aspect-ratio:1;animation:copy-prompt-shimmer-slide var(--speed) ease-in-out infinite alternate}.copy-prompt-spark-conic{position:absolute;inset:-100%;width:auto;aspect-ratio:1;background:conic-gradient(\n from calc(270deg - (var(--spread) * 0.5)),\n transparent 0,\n var(--shimmer-color) var(--spread),\n transparent var(--spread)\n );animation:copy-prompt-spin-around calc(var(--speed) * 2) infinite linear}.copy-prompt-backdrop{position:absolute;inset:var(--cut);z-index:-20;border-radius:inherit;background-color:var(--copy-prompt-bg);pointer-events:none}.copy-prompt-highlight{position:absolute;inset:0;z-index:0;border-radius:inherit;box-shadow:inset 0 -8px 10px #ffffff1f;transition:box-shadow 300ms;pointer-events:none}.copy-prompt-button:hover .copy-prompt-highlight{box-shadow:inset 0 -6px 10px #ffffff3f}.copy-prompt-button:active .copy-prompt-highlight{box-shadow:inset 0 -10px 10px #ffffff3f}@keyframes copy-prompt-shimmer-slide{to{transform:translate(calc(100cqw - 100%), 0)}}@keyframes copy-prompt-spin-around{0%{transform:rotate(0)}15%,35%{transform:rotate(90deg)}65%,85%{transform:rotate(270deg)}100%{transform:rotate(360deg)}}@media (prefers-reduced-motion: reduce){.copy-prompt-spark-track,.copy-prompt-spark-conic{animation:none}}"}],"page":{"pagePath":"api-reference/devices/read-your-device","slug":"/api-reference/devices/read-your-device","pageMetadata":{"title":"Read your Device","description":"Returns a device and its approved roots. Default scope exposes only the caller's devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found.\n\n\u003csub>Scope: `devices:read`\u003c/sub>","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/devices/{deviceId}","href":"/api-reference/devices/read-your-device","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a device and its approved roots. Default scope exposes only the caller’s devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found.\"\n }), \"\\n\", _jsxs(\"sub\", {\n children: [\"Scope: \", _jsx(_components.code, {\n children: \"devices:read\"\n })]\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":"Read your Device","description":"Returns a device and its approved roots. Default scope exposes only the caller's devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found.\n\n\u003csub>Scope: `devices:read`\u003c/sub>","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/devices/{deviceId}","href":"/api-reference/devices/read-your-device","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ara-90a60a07/1839bb79699ce185/copy-prompt.js"],"openApiReferenceData":{"operation":{"operationId":"getDevice","x-reason-mcp-description":"Returns one Device under `device`, with its approved `roots`, `status`, `online`, `compatible` and `compatibility_reason`, to check before targeting it. It reads the caller's Devices unless `scope` is workspace, which requires owner or admin.","tags":["Devices"],"summary":"Read your Device","description":"Returns a device and its approved roots. Default scope exposes only the caller's devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found.\n\n\u003csub>Scope: `devices:read`\u003c/sub>","parameters":["657746bc-c196-4386-b30d-1dd60ac35b78"],"responses":{"200":"96fa18c0-7180-486d-8ca4-6a6dd217093c","401":"c5fc23db-b601-4f9b-8230-8427393009d4","403":"ea054a80-1b93-4cf0-abfd-1857405be3d9","404":"9092a56c-8eaa-4a0b-a64e-252ab9bb31c0","429":"42e97231-b59d-479e-8be1-5f185886b305"},"security":["6092e212-0e21-4c18-8f03-86a6672b9309"],"method":"get","type":"path","servers":["dfc843e3-9382-4394-89ac-023b91b82ceb"],"path":"/v3/organizations/{orgId}/devices/{deviceId}","baseUrlOptions":["https://api.reasonmachines.com"],"title":"Read your Device","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"657746bc-c196-4386-b30d-1dd60ac35b78":{"in":"query","name":"scope","required":false,"description":"Whose Devices to search: the caller's own, or every member's Device in the workspace, which only owners and admins may read.","schema":{"type":"string","enum":["owned","workspace"],"default":"owned","isRequired":false,"description":"Whose Devices to search: the caller's own, or every member's Device in the workspace, which only owners and admins may read.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"c40e0d09-6b84-4ac2-b72e-e2593eb5bc52":{"name":"orgId","in":"path","required":true,"description":"Organization id or slug. Resolve it with `GET /v3/self`.","schema":{"type":"string","isRequired":true,"description":"Organization id or slug. Resolve it with `GET /v3/self`.","uniqueKey":"","typeLabel":"string"}},"3ba5d776-3de9-41c7-9ad7-6e2a0f874ca7":{"name":"deviceId","description":"The owned Device id, returned as `id` by `listDevices`.","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The owned Device id, returned as `id` by `listDevices`.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"96fa18c0-7180-486d-8ca4-6a6dd217093c":{"description":"Owned Device.","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Device id; pass it as `deviceId`.","isRequired":true,"uniqueKey":"device.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Name the Device reported at enrollment.","isRequired":true,"uniqueKey":"device.name","typeLabel":"string"},"kind":{"type":"string","enum":["mac","headless"],"description":"The Mac app's Device, or a headless worker such as `reason connect`.","isRequired":true,"uniqueKey":"device.kind","typeLabel":"enum\u003cstring>"},"os":{"type":"string","description":"Operating system the Device reported.","isRequired":true,"uniqueKey":"device.os","typeLabel":"string"},"architecture":{"type":"string","description":"CPU architecture, such as `arm64`.","isRequired":true,"uniqueKey":"device.architecture","typeLabel":"string"},"device_model":{"oneOf":[{"description":"Hardware model, when reported.","type":"string","isRequired":true,"uniqueKey":"device.device_model.oneOf.0","typeLabel":"string"},{"description":"Hardware model, when reported.","type":"null","isRequired":true,"uniqueKey":"device.device_model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.device_model","typeLabel":"string | null"},"device_chip":{"oneOf":[{"description":"Processor, when reported.","type":"string","isRequired":true,"uniqueKey":"device.device_chip.oneOf.0","typeLabel":"string"},{"description":"Processor, when reported.","type":"null","isRequired":true,"uniqueKey":"device.device_chip.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.device_chip","typeLabel":"string | null"},"device_location":{"oneOf":[{"description":"Location the Device reported, when known.","type":"string","isRequired":true,"uniqueKey":"device.device_location.oneOf.0","typeLabel":"string"},{"description":"Location the Device reported, when known.","type":"null","isRequired":true,"uniqueKey":"device.device_location.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.device_location","typeLabel":"string | null"},"reason_runtime_version":{"type":"string","description":"Version of the Reason runtime on the Device.","isRequired":true,"uniqueKey":"device.reason_runtime_version","typeLabel":"string"},"ara_runtime_version":{"type":"string","deprecated":true,"description":"Deprecated: use `reason_runtime_version` (same value).","isRequired":true,"uniqueKey":"device.ara_runtime_version","typeLabel":"string"},"bridge_version":{"type":"string","description":"Version of the Device's connection bridge.","isRequired":true,"uniqueKey":"device.bridge_version","typeLabel":"string"},"status":{"type":"string","enum":["active","revoked","expired"],"description":"Whether the Device's enrollment is still valid.","isRequired":true,"uniqueKey":"device.status","typeLabel":"enum\u003cstring>"},"lifecycle":{"oneOf":[{"type":"string","description":"For a headless worker: long-lived, or short-lived for one task; null for a Mac.","enum":["persistent","ephemeral"],"isRequired":true,"uniqueKey":"device.lifecycle.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"For a headless worker: long-lived, or short-lived for one task; null for a Mac.","isRequired":true,"uniqueKey":"device.lifecycle.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.lifecycle","typeLabel":"enum\u003cstring> | null"},"expires_at":{"oneOf":[{"description":"When the enrollment expires; null when it does not.","type":"string","isRequired":true,"uniqueKey":"device.expires_at.oneOf.0","typeLabel":"string"},{"description":"When the enrollment expires; null when it does not.","type":"null","isRequired":true,"uniqueKey":"device.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.expires_at","typeLabel":"string | null"},"last_seen_at":{"oneOf":[{"description":"Time of the Device's last heartbeat.","type":"string","isRequired":true,"uniqueKey":"device.last_seen_at.oneOf.0","typeLabel":"string"},{"description":"Time of the Device's last heartbeat.","type":"null","isRequired":true,"uniqueKey":"device.last_seen_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.last_seen_at","typeLabel":"string | null"},"online":{"type":"boolean","description":"Whether the Device is connected now.","isRequired":true,"uniqueKey":"device.online","typeLabel":"boolean"},"compatible":{"type":"boolean","description":"Whether a Session can run on the Device now.","isRequired":true,"uniqueKey":"device.compatible","typeLabel":"boolean"},"compatibility_reason":{"oneOf":[{"type":"string","description":"Why a Session cannot run on it, when `compatible` is false.","enum":["offline","protocol_unsupported","worker_update_required","execution_ineligible","file_access_only","revoked"],"isRequired":true,"uniqueKey":"device.compatibility_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why a Session cannot run on it, when `compatible` is false.","isRequired":true,"uniqueKey":"device.compatibility_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.compatibility_reason","typeLabel":"enum\u003cstring> | null"},"created_at":{"type":"string","description":"When the Device enrolled.","isRequired":true,"uniqueKey":"device.created_at","typeLabel":"string"},"updated_at":{"type":"string","description":"When the Device's record last changed.","isRequired":true,"uniqueKey":"device.updated_at","typeLabel":"string"},"protocol_version":{"type":"integer","description":"Device protocol version it speaks.","isRequired":true,"uniqueKey":"device.protocol_version","typeLabel":"integer"},"capabilities":{"type":"object","description":"Features the Device reported supporting.","isRequired":true,"uniqueKey":"device.capabilities","typeLabel":"object"},"roots":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"Root id; pass it as `rootId` to change or remove this folder.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"label":{"type":"string","description":"Display name of the folder.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].label","typeLabel":"string"},"path_fingerprint":{"type":"string","description":"Keyed fingerprint of the folder's path; the raw path is never published.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].path_fingerprint","typeLabel":"string"},"repository_identity":{"oneOf":[{"description":"Git repository the folder holds, when the Device reported one.","type":"string","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].repository_identity.oneOf.0","typeLabel":"string"},{"description":"Git repository the folder holds, when the Device reported one.","type":"null","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].repository_identity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].repository_identity","typeLabel":"string | null"},"permissions":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"device.roots.items.[INDEX].permissions.additionalProperties","typeLabel":"boolean"},"description":"Current permissions (read, write, execute, discover_environment, expose_mcp) granted in this folder.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].permissions","typeLabel":"object"},"permission_ceiling":{"oneOf":[{"description":"Highest permissions enrollment approved; a grant change cannot exceed them.","type":"object","additionalProperties":{"type":"boolean","uniqueKey":"device.roots.items.[INDEX].permission_ceiling.oneOf.0.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].permission_ceiling.oneOf.0","typeLabel":"object"},{"description":"Highest permissions enrollment approved; a grant change cannot exceed them.","type":"null","additionalProperties":{"type":"boolean","uniqueKey":"device.roots.items.[INDEX].permission_ceiling.oneOf.1.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].permission_ceiling.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].permission_ceiling","typeLabel":"object | null"},"execution_mode":{"oneOf":[{"type":"string","description":"Where commands in this folder run: confined to a sandbox, or directly on the host.","enum":["confined","host"],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Where commands in this folder run: confined to a sandbox, or directly on the host.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode","typeLabel":"enum\u003cstring> | null"},"execution_mode_ceiling":{"oneOf":[{"type":"string","description":"Highest execution mode enrollment approved.","enum":["confined","host"],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode_ceiling.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Highest execution mode enrollment approved.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode_ceiling.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"device.roots.items.[INDEX].execution_mode_ceiling","typeLabel":"enum\u003cstring> | null"},"grant_revision":{"type":"integer","description":"Revision of this grant; pass it as `expected_grant_revision` to change it.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].grant_revision","typeLabel":"integer"},"status":{"type":"string","enum":["active","revoked"],"description":"Whether sessions can still use the folder.","isRequired":true,"uniqueKey":"device.roots.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["id","label","path_fingerprint","repository_identity","permissions","permission_ceiling","execution_mode","execution_mode_ceiling","grant_revision","status"],"uniqueKey":"device.roots.items.[INDEX]","typeLabel":"object"},"description":"Folders approved on the Device, with their grants.","isRequired":true,"uniqueKey":"device.roots","typeLabel":"object[]"},"custom_name":{"oneOf":[{"description":"Name the owner gave the Device, if any.","type":"string","uniqueKey":"device.custom_name.oneOf.0","typeLabel":"string"},{"description":"Name the owner gave the Device, if any.","type":"null","uniqueKey":"device.custom_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"device.custom_name","typeLabel":"string | null"},"machine_id":{"oneOf":[{"description":"Machine this headless worker serves, or null for a personal Device.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"device.machine_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"Machine this headless worker serves, or null for a personal Device.","type":"null","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"device.machine_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"device.machine_id","typeLabel":"string\u003cuuid> | null"},"folder_lane_of":{"oneOf":[{"description":"For a further lane of a CLI folder (a second `reason \"PROMPT\"` running in the same folder at once): the folder's main Device. Lists in Reason show only that Device.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"device.folder_lane_of.oneOf.0","typeLabel":"string\u003cuuid>"},{"description":"For a further lane of a CLI folder (a second `reason \"PROMPT\"` running in the same folder at once): the folder's main Device. Lists in Reason show only that Device.","type":"null","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"device.folder_lane_of.oneOf.1","typeLabel":"null"}],"uniqueKey":"device.folder_lane_of","typeLabel":"string\u003cuuid> | null"},"load":{"description":"What the computer said about its own load in the last 90 seconds, while it is online. Absent when its worker does not report it (an older CLI, or Windows) or has not reported recently.","type":"object","properties":{"one_minute":{"type":"number","description":"The computer's 1-minute load average.","isRequired":true,"uniqueKey":"device.load.one_minute","typeLabel":"number"},"cpus":{"type":"integer","description":"Its logical CPU count.","isRequired":true,"uniqueKey":"device.load.cpus","typeLabel":"integer"},"busy":{"type":"boolean","description":"True when the load is at least two runnable tasks per CPU: work already waits for a CPU, so more work there is slow and can time out.","isRequired":true,"uniqueKey":"device.load.busy","typeLabel":"boolean"},"observed_at":{"type":"string","description":"When the server took this report.","isRequired":true,"uniqueKey":"device.load.observed_at","typeLabel":"string"}},"required":["one_minute","cpus","busy","observed_at"],"uniqueKey":"device.load","typeLabel":"object"},"direct_access_enabled":{"description":"The owner's Direct device access choice (Settings > Network): while false, Sessions cannot run on this personal Device. Absent for Machine and compute workers.","type":"boolean","uniqueKey":"device.direct_access_enabled","typeLabel":"boolean"},"direct_access_revision":{"description":"Revision of that choice; pass it as `expected_revision` to updateDeviceDirectAccess.","type":"integer","uniqueKey":"device.direct_access_revision","typeLabel":"integer"},"direct_access_stopping":{"description":"True while work stopped by turning direct access off is still winding down.","type":"boolean","uniqueKey":"device.direct_access_stopping","typeLabel":"boolean"},"can_manage_direct_access":{"description":"Whether the caller may change this Device's direct access.","type":"boolean","uniqueKey":"device.can_manage_direct_access","typeLabel":"boolean"}},"required":["id","name","kind","os","architecture","device_model","device_chip","device_location","reason_runtime_version","ara_runtime_version","bridge_version","status","lifecycle","expires_at","last_seen_at","online","compatible","compatibility_reason","created_at","updated_at","protocol_version","capabilities","roots"],"example":{"id":"11111111-1111-4111-8111-111111111111","name":"Build worker","kind":"headless","os":"linux","architecture":"arm64","device_model":null,"device_chip":null,"device_location":null,"reason_runtime_version":"1.0.0","ara_runtime_version":"1.0.0","bridge_version":"1.0.0","status":"active","lifecycle":"persistent","expires_at":"2026-10-23T09:00:00Z","last_seen_at":"2026-09-23T09:00:00Z","online":false,"compatible":false,"compatibility_reason":"offline","created_at":"2026-09-23T09:00:00Z","updated_at":"2026-09-23T09:00:00Z","protocol_version":1,"capabilities":{},"roots":[]},"isRequired":true,"uniqueKey":"device","typeLabel":"object"}},"required":["device"],"uniqueKey":"","typeLabel":"object"},"example":{"device":{"id":"11111111-1111-4111-8111-111111111111","name":"Build worker","kind":"headless","os":"linux","architecture":"arm64","device_model":null,"device_chip":null,"device_location":null,"reason_runtime_version":"1.0.0","ara_runtime_version":"1.0.0","bridge_version":"1.0.0","status":"active","lifecycle":"persistent","expires_at":"2026-10-23T09:00:00Z","last_seen_at":"2026-09-23T09:00:00Z","online":false,"compatible":false,"compatibility_reason":"offline","created_at":"2026-09-23T09:00:00Z","updated_at":"2026-09-23T09:00:00Z","protocol_version":1,"capabilities":{},"roots":[]}},"examples":{"Example":{"title":"Example","value":{"device":{"id":"11111111-1111-4111-8111-111111111111","name":"Build worker","kind":"headless","os":"linux","architecture":"arm64","device_model":null,"device_chip":null,"device_location":null,"reason_runtime_version":"1.0.0","ara_runtime_version":"1.0.0","bridge_version":"1.0.0","status":"active","lifecycle":"persistent","expires_at":"2026-10-23T09:00:00Z","last_seen_at":"2026-09-23T09:00:00Z","online":false,"compatible":false,"compatibility_reason":"offline","created_at":"2026-09-23T09:00:00Z","updated_at":"2026-09-23T09:00:00Z","protocol_version":1,"capabilities":{},"roots":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"c5fc23db-b601-4f9b-8230-8427393009d4":{"description":"Missing, invalid, or expired key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.1.request_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.1.request_id","typeLabel":"string | null"}},"uniqueKey":"error.oneOf.1","typeLabel":"object"}],"uniqueKey":"error","typeLabel":"string | object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"required_scope":{"type":"string","description":"The capability required when the request was denied for a missing scope.","uniqueKey":"required_scope","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"missing_bearer","message":"Authorization required"},"examples":{"Example":{"title":"Example","value":{"error":"missing_bearer","message":"Authorization required"}}},"exampleType":"examples"}},"exampleType":"examples"},"ea054a80-1b93-4cf0-abfd-1857405be3d9":{"description":"The key lacks the required scope or role.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.1.request_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.1.request_id","typeLabel":"string | null"}},"uniqueKey":"error.oneOf.1","typeLabel":"object"}],"uniqueKey":"error","typeLabel":"string | object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"required_scope":{"type":"string","description":"The capability required when the request was denied for a missing scope.","uniqueKey":"required_scope","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"missing_scope","required_scope":"sessions:read"},"examples":{"Example":{"title":"Example","value":{"error":"missing_scope","required_scope":"sessions:read"}}},"exampleType":"examples"}},"exampleType":"examples"},"9092a56c-8eaa-4a0b-a64e-252ab9bb31c0":{"description":"Device not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"42e97231-b59d-479e-8be1-5f185886b305":{"description":"Too many requests. Retry after the number of seconds in the `Retry-After` response header.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":1},"required":true}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.1.message","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","uniqueKey":"error.oneOf.1.request_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error.oneOf.1.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.1.request_id","typeLabel":"string | null"}},"uniqueKey":"error.oneOf.1","typeLabel":"object"}],"uniqueKey":"error","typeLabel":"string | object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"required_scope":{"type":"string","description":"The capability required when the request was denied for a missing scope.","uniqueKey":"required_scope","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"rate_limited","message":"This API key exceeded its request-rate limit"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"rate_limited","message":"This API key exceeded its request-rate limit"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6092e212-0e21-4c18-8f03-86a6672b9309":{"reasonApiKey":{"type":"http","scheme":"bearer","bearerFormat":"reason_\u003chex> (legacy: ara_\u003chex>)","description":"Your Reason API key from Settings › API keys. New keys use `reason_`; legacy `ara_` keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).","scopes":["devices:read"],"schemeName":"reasonApiKey"}}},"servers":{"dfc843e3-9382-4394-89ac-023b91b82ceb":{"url":"https://api.reasonmachines.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"reason_\u003chex> (legacy: ara_\u003chex>)","description":"Your Reason API key from Settings › API keys. New keys use `reason_`; legacy `ara_` keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).","scopes":["devices:read"],"schemeName":"reasonApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Reason API key from Settings › API keys. New keys use `reason_`; legacy `ara_` keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"reasonApiKey","name":"Authorization"}],"title":"reasonApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"ara-90a60a07","siteName":"Reason Documentation","title":"Read your Device - Reason Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T11:20:32.989Z","originalFileLocation":"api-reference/devices/read-your-device.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}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=\"Returns a device and its approved roots. Default scope exposes only the caller\u0026#x27;s devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found. Scope: devices:read\">\u003cmeta data-mint-head name=\"application-name\" content=\"Reason Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://reasonmachines.com/favicon-512.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://reasonmachines.com/favicon-512.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://reasonmachines.com/favicon-512.png\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/png\" href=\"https://reasonmachines.com/favicon-512.png\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read your Device - Reason Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a device and its approved roots. Default scope exposes only the caller\u0026#x27;s devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found. Scope: devices:read\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Reason Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.reasonmachines.com/api-reference/devices/read-your-device\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ara-90a60a07.mintlify.site/_mintlify/api/og/v2?division=Devices\u0026amp;title=Read+your+Device\u0026amp;description=Returns+a+device+and+its+approved+roots.+Default+scope+exposes+only+the+caller%27s+devices%3B+scope%3Dworkspace+requires+an+owner+or+admin.+Inspect+status%2C+online%2C+co\u0026amp;theme=e15f170bb306065d806780df\u0026amp;signature=3b19614cdde00e830597d523266e1d342a9746b5679a02823b8b9b2f7a4b80bf\">\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=\"Read your Device - Reason Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a device and its approved roots. Default scope exposes only the caller\u0026#x27;s devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found. Scope: devices:read\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ara-90a60a07.mintlify.site/_mintlify/api/og/v2?division=Devices\u0026amp;title=Read+your+Device\u0026amp;description=Returns+a+device+and+its+approved+roots.+Default+scope+exposes+only+the+caller%27s+devices%3B+scope%3Dworkspace+requires+an+owner+or+admin.+Inspect+status%2C+online%2C+co\u0026amp;theme=e15f170bb306065d806780df\u0026amp;signature=3b19614cdde00e830597d523266e1d342a9746b5679a02823b8b9b2f7a4b80bf\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/ara-90a60a07/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Reason Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0d0d0d\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.reasonmachines.com/api-reference/devices/read-your-device\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/devices/read-your-device.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.reasonmachines.com/#organization\",\"name\":\"Reason Documentation\",\"url\":\"https://docs.reasonmachines.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://reasonmachines.com/reason-logo/reason-logo-black-transparent-512.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.reasonmachines.com#website\",\"name\":\"Reason Documentation\",\"url\":\"https://docs.reasonmachines.com\",\"publisher\":{\"@id\":\"https://docs.reasonmachines.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device#webpage\",\"url\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device\",\"name\":\"Read your Device\",\"description\":\"Returns a device and its approved roots. Default scope exposes only the caller's devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found. Scope: devices:read\",\"dateModified\":\"2026-11-17T11:20:32.989Z\",\"isPartOf\":{\"@id\":\"https://docs.reasonmachines.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.reasonmachines.com/api-reference/account/verify-credentials\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Devices\",\"item\":\"https://docs.reasonmachines.com/api-reference/devices/list-your-devices\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read your Device\",\"item\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device#apireference\",\"headline\":\"Read your Device\",\"name\":\"Read your Device\",\"description\":\"Returns a device and its approved roots. Default scope exposes only the caller's devices; scope=workspace requires an owner or admin. Inspect status, online, compatible and compatibility_reason before choosing an execution target. Invalid or inaccessible IDs return 404 device_not_found. Scope: devices:read\",\"url\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device\",\"mainEntityOfPage\":{\"@id\":\"https://docs.reasonmachines.com/api-reference/devices/read-your-device#webpage\"},\"dateModified\":\"2026-11-17T11:20:32.989Z\",\"publisher\":{\"@id\":\"https://docs.reasonmachines.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.reasonmachines.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Reason Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Reason Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/devices/read-your-device.md","siteName":"Reason Documentation","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guide"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/docs/api-overview"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Verify credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/self","href":"/api-reference/account/verify-credentials"},{"title":"Read backend deployment identity","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/deployment","href":"/api-reference/account/read-backend-deployment-identity"},{"title":"Fetch the OpenAPI document","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/openapi.json","href":"/api-reference/account/fetch-the-openapi-document"},{"title":"List Early Access features","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/early-access","href":"/api-reference/account/list-early-access-features"},{"title":"Read workspace readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/self/readiness","href":"/api-reference/account/read-workspace-readiness"}]},{"group":"Feedback","pages":[{"title":"Report agent feedback","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/feedback","href":"/api-reference/feedback/report-agent-feedback"}]},{"group":"Machines","pages":[{"title":"Approve a worker with a Machine token","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/machines/enrollment-tickets","href":"/api-reference/machines/approve-a-worker-with-a-machine-token"},{"title":"List Machines","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/machines","href":"/api-reference/machines/list-machines"},{"title":"Create a Machine","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/machines","href":"/api-reference/machines/create-a-machine"},{"title":"Read a Machine","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/machines/{machine}","href":"/api-reference/machines/read-a-machine"},{"title":"Delete a Machine","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/machines/{machine}","href":"/api-reference/machines/delete-a-machine"},{"title":"Approve a worker for a Machine","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/machines/{machine}/enrollment-tickets","href":"/api-reference/machines/approve-a-worker-for-a-machine"},{"title":"List Machine tokens","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/machines/{machine}/tokens","href":"/api-reference/machines/list-machine-tokens"},{"title":"Create a Machine token","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/machines/{machine}/tokens","href":"/api-reference/machines/create-a-machine-token"},{"title":"Revoke a Machine token","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/machines/{machine}/tokens/{tokenId}","href":"/api-reference/machines/revoke-a-machine-token"}]},{"group":"Agent network","pages":[{"title":"Get a Reason Network proof for this computer","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/network/proof","href":"/api-reference/agent-network/get-a-reason-network-proof-for-this-computer"},{"title":"List your Reason Network teams","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/network/teams","href":"/api-reference/agent-network/list-your-reason-network-teams"},{"title":"Register one of your Reason Network teams","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/network/teams","href":"/api-reference/agent-network/register-one-of-your-reason-network-teams"},{"title":"Remove a Reason Network team nobody is on any more","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/network/teams","href":"/api-reference/agent-network/remove-a-reason-network-team-nobody-is-on-any-more"},{"title":"Remove a Reason Network team from your directory","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/network/teams/forget","href":"/api-reference/agent-network/remove-a-reason-network-team-from-your-directory"},{"title":"Say this computer left one of your Reason Network teams","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/network/teams/leave","href":"/api-reference/agent-network/say-this-computer-left-one-of-your-reason-network-teams"},{"title":"Get the workspace's agent network","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-network","href":"/api-reference/agent-network/get-the-workspaces-agent-network"},{"title":"Replace the workspace's agent network join link","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/agent-network","href":"/api-reference/agent-network/replace-the-workspaces-agent-network-join-link"},{"title":"Start the workspace's agent network, or get the one that exists","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network","href":"/api-reference/agent-network/start-the-workspaces-agent-network-or-get-the-one-that-exists"},{"title":"List the agents on the caller's Reason Network","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-network/agents","href":"/api-reference/agent-network/list-the-agents-on-the-callers-reason-network"},{"title":"Read the caller's Reason Network inbox","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/inbox","href":"/api-reference/agent-network/read-the-callers-reason-network-inbox"},{"title":"Rename the caller's session on Reason Network","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/agent-network/me","href":"/api-reference/agent-network/rename-the-callers-session-on-reason-network"},{"title":"Ask an agent on the caller's Reason Network","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/messages","href":"/api-reference/agent-network/ask-an-agent-on-the-callers-reason-network"},{"title":"Move the caller's connection to another of its person's Reason Network networks","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/agent-network/network","href":"/api-reference/agent-network/move-the-callers-connection-to-another-of-its-persons-reason-network-networks"},{"title":"List the Reason Network networks the caller's connection can join","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-network/networks","href":"/api-reference/agent-network/list-the-reason-network-networks-the-callers-connection-can-join"},{"title":"Claim the next agent network call this computer carries","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/relay/claim","href":"/api-reference/agent-network/claim-the-next-agent-network-call-this-computer-carries"},{"title":"Report the outcome of a claimed agent network call","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/relay/jobs/{jobId}","href":"/api-reference/agent-network/report-the-outcome-of-a-claimed-agent-network-call"},{"title":"Hand over messages that reached the sessions this computer sends from or carries","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/relay/replies","href":"/api-reference/agent-network/hand-over-messages-that-reached-the-sessions-this-computer-sends-from-or-carries"},{"title":"Keep this computer's agents' Network messages (retired)","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/relay/transcript","href":"/api-reference/agent-network/keep-this-computers-agents-network-messages-retired"},{"title":"Report aggregate network usage","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/relay/usage","href":"/api-reference/agent-network/report-aggregate-network-usage"},{"title":"Send a message on the caller's Reason Network","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/agent-network/send","href":"/api-reference/agent-network/send-a-message-on-the-callers-reason-network"},{"title":"Check an outgoing Network message without resending","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-network/send/status","href":"/api-reference/agent-network/check-an-outgoing-network-message-without-resending"},{"title":"List the agent sessions on the caller's Reason Network","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-network/team","href":"/api-reference/agent-network/list-the-agent-sessions-on-the-callers-reason-network"},{"title":"Wake the caller's routine when a message reaches its Reason Network inbox","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/agent-network/wake","href":"/api-reference/agent-network/wake-the-callers-routine-when-a-message-reaches-its-reason-network-inbox"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations","href":"/api-reference/organizations/create-an-organization"},{"title":"Retrieve an organization","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}","href":"/api-reference/organizations/retrieve-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}","href":"/api-reference/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}","href":"/api-reference/organizations/update-an-organization"},{"title":"Create a single-use benchmark workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/ephemeral-workspaces","href":"/api-reference/organizations/create-a-single-use-benchmark-workspace"},{"title":"Retire a single-use benchmark workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/ephemeral-workspaces/{workspaceId}/retire","href":"/api-reference/organizations/retire-a-single-use-benchmark-workspace"}]},{"group":"Agent Auth","pages":[{"title":"List Reason models","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-auth/models","href":"/api-reference/agent-auth/list-reason-models"},{"title":"Get Reason inference availability","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/agent-auth/status","href":"/api-reference/agent-auth/get-reason-inference-availability"}]},{"group":"Attachments","pages":[{"title":"List attachments","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/attachments","href":"/api-reference/attachments/list-attachments"},{"title":"Upload an attachment","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/attachments","href":"/api-reference/attachments/upload-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/attachments/{attachmentId}","href":"/api-reference/attachments/download-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/attachments/{attachmentId}","href":"/api-reference/attachments/delete-an-attachment"},{"title":"Download an attachment (named)","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/attachments/{attachmentId}/{filename}","href":"/api-reference/attachments/download-an-attachment-named"}]},{"group":"Audit Logs","pages":[{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/audit-logs","href":"/api-reference/audit-logs/list-audit-log-entries"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations","href":"/api-reference/automations/list-automations"},{"title":"Create an automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/automations","href":"/api-reference/automations/create-an-automation"},{"title":"Retrieve an automation","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations/{automationId}","href":"/api-reference/automations/retrieve-an-automation"},{"title":"Delete an automation","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/automations/{automationId}","href":"/api-reference/automations/delete-an-automation"},{"title":"Update an automation","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/automations/{automationId}","href":"/api-reference/automations/update-an-automation"},{"title":"Read the creator-private typed action","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations/{automationId}/action","href":"/api-reference/automations/read-the-creator-private-typed-action"},{"title":"Pin an immutable action and schedule revision","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/automations/{automationId}/action","href":"/api-reference/automations/pin-an-immutable-action-and-schedule-revision"},{"title":"Remove the direct configuration and pause future admission","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/automations/{automationId}/action","href":"/api-reference/automations/remove-the-direct-configuration-and-pause-future-admission"},{"title":"List up to 100 direct occurrence statuses","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations/{automationId}/executions","href":"/api-reference/automations/list-up-to-100-direct-occurrence-statuses"},{"title":"Observe one direct occurrence","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations/{automationId}/executions/{executionId}","href":"/api-reference/automations/observe-one-direct-occurrence"},{"title":"Request cancellation of an admitted occurrence","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/automations/{automationId}/executions/{executionId}/cancel","href":"/api-reference/automations/request-cancellation-of-an-admitted-occurrence"},{"title":"Admit one occurrence now","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/automations/{automationId}/run","href":"/api-reference/automations/admit-one-occurrence-now"},{"title":"List an automation's triggers","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/automations/{automationId}/triggers","href":"/api-reference/automations/list-an-automations-triggers"},{"title":"Add a trigger to an automation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/automations/{automationId}/triggers","href":"/api-reference/automations/add-a-trigger-to-an-automation"},{"title":"Remove a trigger from an automation","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/automations/{automationId}/triggers/{triggerId}","href":"/api-reference/automations/remove-a-trigger-from-an-automation"}]},{"group":"Capabilities","pages":[{"title":"Discover public operations admitted by this credential's scopes","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/capabilities","href":"/api-reference/capabilities/discover-public-operations-admitted-by-this-credentials-scopes"}]},{"group":"Workspace events","pages":[{"title":"Stream workspace changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/changes","href":"/api-reference/workspace-events/stream-workspace-changes"},{"title":"List event webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/event-webhooks","href":"/api-reference/workspace-events/list-event-webhooks"},{"title":"Register an event webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/event-webhooks","href":"/api-reference/workspace-events/register-an-event-webhook"},{"title":"Get an event webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/event-webhooks/{webhookId}","href":"/api-reference/workspace-events/get-an-event-webhook"},{"title":"Delete an event webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/event-webhooks/{webhookId}","href":"/api-reference/workspace-events/delete-an-event-webhook"},{"title":"Update an event webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/event-webhooks/{webhookId}","href":"/api-reference/workspace-events/update-an-event-webhook"},{"title":"Stream workspace events","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/events","href":"/api-reference/workspace-events/stream-workspace-events"}]},{"group":"Cloud Access","pages":[{"title":"Read cloud access","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/cloud-access","href":"/api-reference/cloud-access/read-cloud-access"},{"title":"Create or replace a cloud access connection","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/cloud-access/{provider}","href":"/api-reference/cloud-access/create-or-replace-a-cloud-access-connection"},{"title":"Delete a cloud access connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/cloud-access/{provider}","href":"/api-reference/cloud-access/delete-a-cloud-access-connection"},{"title":"Test a cloud access connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/cloud-access/{provider}/test","href":"/api-reference/cloud-access/test-a-cloud-access-connection"}]},{"group":"Computers","pages":[{"title":"List workspace computers","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/computers","href":"/api-reference/computers/list-workspace-computers"},{"title":"List a Reason's computers","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons/{reasonId}/computers","href":"/api-reference/computers/list-a-reasons-computers"}]},{"group":"Connections","pages":[{"title":"List service connections and their health","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/connections","href":"/api-reference/connections/list-service-connections-and-their-health"},{"title":"Manage one connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/connections/{adapter}/{id}/{action}","href":"/api-reference/connections/manage-one-connection"}]},{"group":"Tools","pages":[{"title":"List a connected account's MCP tools","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/connections/{connectionId}/tools","href":"/api-reference/tools/list-a-connected-accounts-mcp-tools"},{"title":"Describe one connected MCP tool","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/connections/{connectionId}/tools/{toolName}","href":"/api-reference/tools/describe-one-connected-mcp-tool"},{"title":"Invoke a connected MCP tool without a Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/tool-invocations","href":"/api-reference/tools/invoke-a-connected-mcp-tool-without-a-session"},{"title":"Read an invocation receipt","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/tool-invocations/{id}","href":"/api-reference/tools/read-an-invocation-receipt"},{"title":"Request cancellation of an invocation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/tool-invocations/{id}/cancel","href":"/api-reference/tools/request-cancellation-of-an-invocation"}]},{"group":"Consumption","pages":[{"title":"Get daily consumption","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/consumption/daily","href":"/api-reference/consumption/get-daily-consumption"},{"title":"Get usage quota","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/usage/quota","href":"/api-reference/consumption/get-usage-quota"},{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/usage/summary","href":"/api-reference/consumption/get-usage-summary"}]},{"group":"Devices","pages":[{"title":"List your Devices","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/devices","href":"/api-reference/devices/list-your-devices"},{"title":"Approve a headless installation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/devices/enrollment-tickets","href":"/api-reference/devices/approve-a-headless-installation"},{"title":"Enroll a headless installation","description":"Approves and redeems a headless enrollment in one request for an API-key or OAuth principal: the same approval as POST .../devices/enrollment-tickets, redeemed at once with its PKCE verifier and the Device's registration and P-256 public key. The Device then authenticates on the signed Device transport. Execution feature gates can return 503.\n\n\u003csub>Scope: `devices:write`\u003c/sub>","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/devices/enrollments","href":"/api-reference/devices/enroll-a-headless-installation"},{"title":"Read your Device","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/devices/{deviceId}","href":"/api-reference/devices/read-your-device"},{"title":"Revoke your Device","description":"Revokes a device owned by the caller and cancels queued or claimed work. Workspace inventory access does not authorize revoking another member's device here. Returns revoked: true, including when the Device is already revoked, or 404 device_not_found for an invalid or inaccessible device.\n\n\u003csub>Scope: `devices:write`\u003c/sub>","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/devices/{deviceId}","href":"/api-reference/devices/revoke-your-device"},{"title":"Rename a Device","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/devices/{deviceId}","href":"/api-reference/devices/rename-a-device"},{"title":"Set your Device's direct access","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/devices/{deviceId}/direct-access","href":"/api-reference/devices/set-your-devices-direct-access"},{"title":"Add a folder to your computer","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/devices/{deviceId}/roots","href":"/api-reference/devices/add-a-folder-to-your-computer"},{"title":"Remove a folder from your computer","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/devices/{deviceId}/roots/{rootId}","href":"/api-reference/devices/remove-a-folder-from-your-computer"},{"title":"Change an approved root grant","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/devices/{deviceId}/roots/{rootId}/grant","href":"/api-reference/devices/change-an-approved-root-grant"},{"title":"List experimental sandbox targets","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sandbox-targets","href":"/api-reference/devices/list-experimental-sandbox-targets"},{"title":"Read sandbox readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sandbox-targets/instances/{instanceId}","href":"/api-reference/devices/read-sandbox-readiness"},{"title":"Stop a sandbox instance","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/sandbox-targets/instances/{instanceId}","href":"/api-reference/devices/stop-a-sandbox-instance"},{"title":"Launch an approved sandbox target","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sandbox-targets/{targetId}/launch","href":"/api-reference/devices/launch-an-approved-sandbox-target"},{"title":"List your SSH connections","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/ssh-connections","href":"/api-reference/devices/list-your-ssh-connections"},{"title":"Add an SSH connection","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/ssh-connections","href":"/api-reference/devices/add-an-ssh-connection"},{"title":"Read your SSH connection","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/ssh-connections/{connectionId}","href":"/api-reference/devices/read-your-ssh-connection"},{"title":"Delete an SSH connection","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/ssh-connections/{connectionId}","href":"/api-reference/devices/delete-an-ssh-connection"},{"title":"Bootstrap a Mac SSH activation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/ssh-connections/{connectionId}/activate","href":"/api-reference/devices/bootstrap-a-mac-ssh-activation"},{"title":"Connect or reconnect over SSH","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/ssh-connections/{connectionId}/connect","href":"/api-reference/devices/connect-or-reconnect-over-ssh"},{"title":"Replace saved SSH credentials","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/ssh-connections/{connectionId}/credentials","href":"/api-reference/devices/replace-saved-ssh-credentials"}]},{"group":"Execution contexts","pages":[{"title":"List contexts owned by this credential","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts","href":"/api-reference/execution-contexts/list-contexts-owned-by-this-credential"},{"title":"Acquire an optional bounded Device/root context","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts","href":"/api-reference/execution-contexts/acquire-an-optional-bounded-deviceroot-context"},{"title":"Inspect a context and measured capabilities","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts/{contextId}","href":"/api-reference/execution-contexts/inspect-a-context-and-measured-capabilities"},{"title":"Close a context and stop renewing its physical resource leases","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/close","href":"/api-reference/execution-contexts/close-a-context-and-stop-renewing-its-physical-resource-leases"},{"title":"Submit a typed files, command, terminal, browser, preview or artifact operation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/operations","href":"/api-reference/execution-contexts/submit-a-typed-files-command-terminal-browser-preview-or-artifact-operation"},{"title":"Renew up to the immutable hard expiry","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/renew","href":"/api-reference/execution-contexts/renew-up-to-the-immutable-hard-expiry"}]},{"group":"Previews","pages":[{"title":"List private previews in an owned context","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts/{contextId}/previews","href":"/api-reference/previews/list-private-previews-in-an-owned-context"},{"title":"Start an owned private HTTP and WebSocket preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/previews","href":"/api-reference/previews/start-an-owned-private-http-and-websocket-preview"},{"title":"Read private preview state","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts/{contextId}/previews/{previewId}","href":"/api-reference/previews/read-private-preview-state"},{"title":"Open an owned ready private preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/previews/{previewId}/access","href":"/api-reference/previews/open-an-owned-ready-private-preview"},{"title":"Close an owned private preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{contextId}/previews/{previewId}/close","href":"/api-reference/previews/close-an-owned-private-preview"}]},{"group":"Checkpoint artifacts","pages":[{"title":"Read checkpoint preparation or sealing status","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/artifacts/{artifactId}","href":"/api-reference/checkpoint-artifacts/read-checkpoint-preparation-or-sealing-status"},{"title":"Delete a retained checkpoint artifact","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/artifacts/{artifactId}","href":"/api-reference/checkpoint-artifacts/delete-a-retained-checkpoint-artifact"},{"title":"Set bounded checkpoint retention","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/artifacts/{artifactId}/retention","href":"/api-reference/checkpoint-artifacts/set-bounded-checkpoint-retention"},{"title":"Prepare a private checkpoint chunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/chunks/prepare","href":"/api-reference/checkpoint-artifacts/prepare-a-private-checkpoint-chunk"},{"title":"Upload exactly the prepared chunk bytes","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/chunks/{artifactId}/content","href":"/api-reference/checkpoint-artifacts/upload-exactly-the-prepared-chunk-bytes"},{"title":"Verify and seal immutable checkpoint bytes","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/chunks/{artifactId}/seal","href":"/api-reference/checkpoint-artifacts/verify-and-seal-immutable-checkpoint-bytes"},{"title":"Register an ordered immutable checkpoint manifest","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/manifests","href":"/api-reference/checkpoint-artifacts/register-an-ordered-immutable-checkpoint-manifest"},{"title":"Read a retained checkpoint and fresh private URLs","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/execution-contexts/{ownerId}/checkpoints/manifests/{artifactId}","href":"/api-reference/checkpoint-artifacts/read-a-retained-checkpoint-and-fresh-private-urls"},{"title":"Read checkpoint preparation or sealing status","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/artifacts/{artifactId}","href":"/api-reference/checkpoint-artifacts/read-checkpoint-preparation-or-sealing-status-1"},{"title":"Delete a retained checkpoint artifact","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/artifacts/{artifactId}","href":"/api-reference/checkpoint-artifacts/delete-a-retained-checkpoint-artifact-1"},{"title":"Set bounded checkpoint retention","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/artifacts/{artifactId}/retention","href":"/api-reference/checkpoint-artifacts/set-bounded-checkpoint-retention-1"},{"title":"Prepare a private checkpoint chunk","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/chunks/prepare","href":"/api-reference/checkpoint-artifacts/prepare-a-private-checkpoint-chunk-1"},{"title":"Upload exactly the prepared chunk bytes","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/chunks/{artifactId}/content","href":"/api-reference/checkpoint-artifacts/upload-exactly-the-prepared-chunk-bytes-1"},{"title":"Verify and seal immutable checkpoint bytes","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/chunks/{artifactId}/seal","href":"/api-reference/checkpoint-artifacts/verify-and-seal-immutable-checkpoint-bytes-1"},{"title":"Register an ordered immutable checkpoint manifest","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/manifests","href":"/api-reference/checkpoint-artifacts/register-an-ordered-immutable-checkpoint-manifest-1"},{"title":"Read a retained checkpoint and fresh private URLs","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{ownerId}/checkpoints/manifests/{artifactId}","href":"/api-reference/checkpoint-artifacts/read-a-retained-checkpoint-and-fresh-private-urls-1"}]},{"group":"Git Connections","pages":[{"title":"List git connections (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/git-connections","href":"/api-reference/git-connections/list-git-connections-deprecated"},{"title":"List repositories for a git connection (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/git-connections/{gitConnectionId}/repositories","href":"/api-reference/git-connections/list-repositories-for-a-git-connection-deprecated"}]},{"group":"Git Plugins","pages":[{"title":"List git plugins","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/git-plugins","href":"/api-reference/git-plugins/list-git-plugins"},{"title":"List repositories for a git plugin","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/git-plugins/{gitPluginId}/repositories","href":"/api-reference/git-plugins/list-repositories-for-a-git-plugin"}]},{"group":"Repositories","pages":[{"title":"List indexed repositories (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/indexed-repositories","href":"/api-reference/repositories/list-indexed-repositories-retired"},{"title":"List repositories","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories","href":"/api-reference/repositories/list-repositories"},{"title":"Bulk enable repositories","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/repositories/bulk-index","href":"/api-reference/repositories/bulk-enable-repositories"},{"title":"Bulk remove repositories","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/repositories/bulk-remove","href":"/api-reference/repositories/bulk-remove-repositories"},{"title":"Disconnect a repository","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/repositories/{owner}/{repo}","href":"/api-reference/repositories/disconnect-a-repository"},{"title":"Get a branch's head commit","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories/{owner}/{repo}/branch-head","href":"/api-reference/repositories/get-a-branchs-head-commit"},{"title":"Delete a repository branch (retired)","deprecated":true,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/repositories/{owner}/{repo}/branches/{branch}","href":"/api-reference/repositories/delete-a-repository-branch-retired"},{"title":"Get repository guardrails","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories/{owner}/{repo}/guardrails","href":"/api-reference/repositories/get-repository-guardrails"},{"title":"Update repository guardrails","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/repositories/{owner}/{repo}/guardrails","href":"/api-reference/repositories/update-repository-guardrails"},{"title":"Enable a repository","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/repositories/{owner}/{repo}/index","href":"/api-reference/repositories/enable-a-repository"},{"title":"Get indexing status (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories/{owner}/{repo}/indexing-status","href":"/api-reference/repositories/get-indexing-status-retired"},{"title":"Get repository wiki (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories/{owner}/{repo}/wiki","href":"/api-reference/repositories/get-repository-wiki-retired"},{"title":"Export repository wiki (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/repositories/{owner}/{repo}/wiki/export","href":"/api-reference/repositories/export-repository-wiki-retired"}]},{"group":"Sessions","pages":[{"title":"List pending input requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/input-requests","href":"/api-reference/sessions/list-pending-input-requests"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Create a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions","href":"/api-reference/sessions/create-a-session"},{"title":"List sessions with insights","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/insights","href":"/api-reference/sessions/list-sessions-with-insights"},{"title":"Start a new session's machine ahead of its create","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/prestart","href":"/api-reference/sessions/start-a-new-sessions-machine-ahead-of-its-create"},{"title":"Retrieve a session","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}","href":"/api-reference/sessions/retrieve-a-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/sessions/{sessionId}","href":"/api-reference/sessions/delete-a-session"},{"title":"Archive a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/archive","href":"/api-reference/sessions/archive-a-session"},{"title":"List attachments","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/attachments","href":"/api-reference/sessions/list-attachments"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/attachments/{attachmentId}","href":"/api-reference/sessions/download-an-attachment"},{"title":"Cancel a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/cancel","href":"/api-reference/sessions/cancel-a-session"},{"title":"Compact a session's context","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/compact","href":"/api-reference/sessions/compact-a-sessions-context"},{"title":"List the conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/conversation","href":"/api-reference/sessions/list-the-conversation"},{"title":"List live session events","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/events","href":"/api-reference/sessions/list-live-session-events"},{"title":"Read session follow-through","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/follow-ups","href":"/api-reference/sessions/read-session-follow-through"},{"title":"Schedule a session check-in","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/follow-ups","href":"/api-reference/sessions/schedule-a-session-check-in"},{"title":"Cancel a session check-in","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/sessions/{sessionId}/follow-ups/{followupId}","href":"/api-reference/sessions/cancel-a-session-check-in"},{"title":"Fork a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/fork","href":"/api-reference/sessions/fork-a-session"},{"title":"List a session's pending input requests","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/input-requests","href":"/api-reference/sessions/list-a-sessions-pending-input-requests"},{"title":"Get an input request","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}","href":"/api-reference/sessions/get-an-input-request"},{"title":"Answer a question","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}/answer","href":"/api-reference/sessions/answer-a-question"},{"title":"Approve a network or permission request","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}/approve","href":"/api-reference/sessions/approve-a-network-or-permission-request"},{"title":"Decline a secret request","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}/cancel","href":"/api-reference/sessions/decline-a-secret-request"},{"title":"Decline a network or permission request","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}/deny","href":"/api-reference/sessions/decline-a-network-or-permission-request"},{"title":"Provide a secret request's value","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/input-requests/{requestId}/secret","href":"/api-reference/sessions/provide-a-secret-requests-value"},{"title":"Get session insights","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/insights","href":"/api-reference/sessions/get-session-insights"},{"title":"Generate session insights","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/insights/generate","href":"/api-reference/sessions/generate-session-insights"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/messages","href":"/api-reference/sessions/list-messages"},{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/messages","href":"/api-reference/sessions/send-a-message"},{"title":"Withdraw a queued message","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/sessions/{sessionId}/messages/{messageId}/queued","href":"/api-reference/sessions/withdraw-a-queued-message"},{"title":"Send a queued message now","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/messages/{messageId}/steer","href":"/api-reference/sessions/send-a-queued-message-now"},{"title":"Move a session to a project","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/project","href":"/api-reference/sessions/move-a-session-to-a-project"},{"title":"Rename a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/rename","href":"/api-reference/sessions/rename-a-session"},{"title":"Retry a session's last turn","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/retry","href":"/api-reference/sessions/retry-a-sessions-last-turn"},{"title":"Edit a message and rewind","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/rewind","href":"/api-reference/sessions/edit-a-message-and-rewind"},{"title":"List shared links","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/shared-links","href":"/api-reference/sessions/list-shared-links"},{"title":"Share a link with the agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/shared-links","href":"/api-reference/sessions/share-a-link-with-the-agent"},{"title":"Revoke a shared link","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/sessions/{sessionId}/shared-links/{linkId}","href":"/api-reference/sessions/revoke-a-shared-link"},{"title":"List session tags","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/tags","href":"/api-reference/sessions/list-session-tags"},{"title":"Replace session tags","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/sessions/{sessionId}/tags","href":"/api-reference/sessions/replace-session-tags"},{"title":"Append session tags","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/tags","href":"/api-reference/sessions/append-session-tags"},{"title":"Replace session tags","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/sessions/{sessionId}/tags","href":"/api-reference/sessions/replace-session-tags-1"},{"title":"Export session trajectory","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/sessions/{sessionId}/trajectory","href":"/api-reference/sessions/export-session-trajectory"},{"title":"Restore a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/sessions/{sessionId}/unarchive","href":"/api-reference/sessions/restore-a-session"}]},{"group":"Jobs","pages":[{"title":"List jobs owned by this credential","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs","href":"/api-reference/jobs/list-jobs-owned-by-this-credential"},{"title":"Submit deterministic work on a granted Device","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/jobs","href":"/api-reference/jobs/submit-deterministic-work-on-a-granted-device"},{"title":"Read job status","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{jobId}","href":"/api-reference/jobs/read-job-status"},{"title":"Cancel work; cleanup is reported separately","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/jobs/{jobId}/cancel","href":"/api-reference/jobs/cancel-work;-cleanup-is-reported-separately"},{"title":"Inspect a job's delegated grants","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{jobId}/delegations","href":"/api-reference/jobs/inspect-a-jobs-delegated-grants"},{"title":"Revoke a job's delegated grant","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/jobs/{jobId}/delegations/{grantId}","href":"/api-reference/jobs/revoke-a-jobs-delegated-grant"},{"title":"Read bounded resumable job lifecycle events","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{jobId}/events","href":"/api-reference/jobs/read-bounded-resumable-job-lifecycle-events"},{"title":"Read bounded owner-private output","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{jobId}/result","href":"/api-reference/jobs/read-bounded-owner-private-output"},{"title":"Observe a job without restarting it","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/jobs/{jobId}/wait","href":"/api-reference/jobs/observe-a-job-without-restarting-it"}]},{"group":"MCP Servers","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/mcp-servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/mcp-servers","href":"/api-reference/mcp-servers/create-an-mcp-server"},{"title":"Inspect an MCP server URL","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/mcp-servers/endpoint/inspect","href":"/api-reference/mcp-servers/inspect-an-mcp-server-url"},{"title":"Retrieve an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/mcp-servers/{id}","href":"/api-reference/mcp-servers/retrieve-an-mcp-server"},{"title":"Delete an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/mcp-servers/{id}","href":"/api-reference/mcp-servers/delete-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/mcp-servers/{id}","href":"/api-reference/mcp-servers/update-an-mcp-server"},{"title":"Import a local MCP OAuth credential","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/mcp-servers/{id}/oauth-import","href":"/api-reference/mcp-servers/import-a-local-mcp-oauth-credential"}]},{"group":"Members","pages":[{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/members/users","href":"/api-reference/members/list-members"},{"title":"Invite a member","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/members/users","href":"/api-reference/members/invite-a-member"},{"title":"Get a member","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/members/users/{userId}","href":"/api-reference/members/get-a-member"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/members/users/{userId}","href":"/api-reference/members/remove-a-member"},{"title":"Set a member's role","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/members/users/{userId}/role","href":"/api-reference/members/set-a-members-role"}]},{"group":"Memory","pages":[{"title":"Read a memory file","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/memory/file","href":"/api-reference/memory/read-a-memory-file"},{"title":"Write a memory file","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/memory/file","href":"/api-reference/memory/write-a-memory-file"},{"title":"Delete a memory file","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/memory/file","href":"/api-reference/memory/delete-a-memory-file"},{"title":"List memory files","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/memory/files","href":"/api-reference/memory/list-memory-files"},{"title":"List memory history","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/memory/history","href":"/api-reference/memory/list-memory-history"},{"title":"Restore a memory revision","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/memory/restore","href":"/api-reference/memory/restore-a-memory-revision"},{"title":"Search memory","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/memory/search","href":"/api-reference/memory/search-memory"}]},{"group":"Metrics","pages":[{"title":"Get usage metrics","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/metrics/usage","href":"/api-reference/metrics/get-usage-metrics"},{"title":"Get queue status","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/queue","href":"/api-reference/metrics/get-queue-status"}]},{"group":"Network policy","pages":[{"title":"Retrieve workspace network policy","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/network-policy","href":"/api-reference/network-policy/retrieve-workspace-network-policy"},{"title":"Replace workspace network policy","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/network-policy","href":"/api-reference/network-policy/replace-workspace-network-policy"}]},{"group":"Onboarding","pages":[{"title":"Mark an approved local secret import complete","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/onboarding/import/complete","href":"/api-reference/onboarding/mark-an-approved-local-secret-import-complete"},{"title":"Poll the browser's local secret import decision","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/onboarding/import/decision","href":"/api-reference/onboarding/poll-the-browsers-local-secret-import-decision"},{"title":"Attach an existing CLI grant to a browser pairing","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/onboarding/import/pairing/claim-existing","href":"/api-reference/onboarding/attach-an-existing-cli-grant-to-a-browser-pairing"},{"title":"Report that a paired local scan could not finish","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/onboarding/import/pairing/failure","href":"/api-reference/onboarding/report-that-a-paired-local-scan-could-not-finish"},{"title":"Create a local onboarding import handoff","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/onboarding/import/summary","href":"/api-reference/onboarding/create-a-local-onboarding-import-handoff"}]},{"group":"Pages","pages":[{"title":"List pages","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/pages","href":"/api-reference/pages/list-pages"},{"title":"Create a page","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/pages","href":"/api-reference/pages/create-a-page"},{"title":"Retrieve a page","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/pages/{pageId}","href":"/api-reference/pages/retrieve-a-page"},{"title":"Delete a page","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/pages/{pageId}","href":"/api-reference/pages/delete-a-page"},{"title":"Update a page","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/pages/{pageId}","href":"/api-reference/pages/update-a-page"},{"title":"Share a page","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/pages/{pageId}/share","href":"/api-reference/pages/share-a-page"}]},{"group":"Plugins","pages":[{"title":"List plugins","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/plugins","href":"/api-reference/plugins/list-plugins"},{"title":"List plugin Reason allowances","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/plugins/reason-allowances","href":"/api-reference/plugins/list-plugin-reason-allowances"},{"title":"Get a plugin sign-in","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/plugins/sign-in/{signInId}","href":"/api-reference/plugins/get-a-plugin-sign-in"},{"title":"Cancel a plugin sign-in","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/plugins/sign-in/{signInId}","href":"/api-reference/plugins/cancel-a-plugin-sign-in"},{"title":"Get a plugin","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/plugins/{slug}","href":"/api-reference/plugins/get-a-plugin"},{"title":"Uninstall a plugin","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/plugins/{slug}","href":"/api-reference/plugins/uninstall-a-plugin"},{"title":"Install a plugin","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/plugins/{slug}/install","href":"/api-reference/plugins/install-a-plugin"},{"title":"Get per-Reason plugin settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/plugins/{slug}/reasons/{reasonId}","href":"/api-reference/plugins/get-per-reason-plugin-settings"},{"title":"Update per-Reason plugin settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/plugins/{slug}/reasons/{reasonId}","href":"/api-reference/plugins/update-per-reason-plugin-settings"},{"title":"Start a plugin sign-in","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/plugins/{slug}/sign-in/start","href":"/api-reference/plugins/start-a-plugin-sign-in"}]},{"group":"Change Request Reviews","pages":[{"title":"List change request reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/pr-reviews","href":"/api-reference/change-request-reviews/list-change-request-reviews"},{"title":"Request a change request review","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/pr-reviews","href":"/api-reference/change-request-reviews/request-a-change-request-review"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/projects","href":"/api-reference/projects/list-projects"},{"title":"Create project","deprecated":true,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/projects","href":"/api-reference/projects/create-project"},{"title":"Retrieve a project","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/projects/{projectId}","href":"/api-reference/projects/retrieve-a-project"},{"title":"Update a project","deprecated":true,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/projects/{projectId}","href":"/api-reference/projects/update-a-project"},{"title":"Archive a project","deprecated":true,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/projects/{projectId}/archive","href":"/api-reference/projects/archive-a-project"},{"title":"Restore a project","deprecated":true,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/projects/{projectId}/unarchive","href":"/api-reference/projects/restore-a-project"}]},{"group":"Provider credentials","pages":[{"title":"List provider credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/provider-credentials","href":"/api-reference/provider-credentials/list-provider-credentials"},{"title":"Connect an Anthropic subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/anthropic","href":"/api-reference/provider-credentials/connect-an-anthropic-subscription"},{"title":"List available providers","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/provider-credentials/catalog","href":"/api-reference/provider-credentials/list-available-providers"},{"title":"Discover pending provider sign-ins","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/provider-credentials/oauth/logins","href":"/api-reference/provider-credentials/discover-pending-provider-sign-ins"},{"title":"Read provider sign-in","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/provider-credentials/oauth/logins/{loginId}","href":"/api-reference/provider-credentials/read-provider-sign-in"},{"title":"Cancel provider sign-in","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/provider-credentials/oauth/logins/{loginId}","href":"/api-reference/provider-credentials/cancel-provider-sign-in"},{"title":"Answer provider sign-in prompt","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/oauth/logins/{loginId}/respond","href":"/api-reference/provider-credentials/answer-provider-sign-in-prompt"},{"title":"Configure a provider credential","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/provider-credentials/{providerId}","href":"/api-reference/provider-credentials/configure-a-provider-credential"},{"title":"Delete a provider credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/provider-credentials/{providerId}","href":"/api-reference/provider-credentials/delete-a-provider-credential"},{"title":"Rename a provider account","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/provider-credentials/{providerId}/accounts/{accountKey}","href":"/api-reference/provider-credentials/rename-a-provider-account"},{"title":"Check a saved provider account","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/{providerId}/accounts/{accountKey}/check","href":"/api-reference/provider-credentials/check-a-saved-provider-account"},{"title":"Read saved provider account usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/provider-credentials/{providerId}/accounts/{accountKey}/usage","href":"/api-reference/provider-credentials/read-saved-provider-account-usage"},{"title":"Start or recover provider sign-in","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/{providerId}/oauth/login-requests","href":"/api-reference/provider-credentials/start-or-recover-provider-sign-in"},{"title":"Start provider sign-in","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/{providerId}/oauth/logins","href":"/api-reference/provider-credentials/start-provider-sign-in"},{"title":"Validate a provider API key","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/provider-credentials/{providerId}/validate","href":"/api-reference/provider-credentials/validate-a-provider-api-key"}]},{"group":"Reasons","pages":[{"title":"List Reasons","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons","href":"/api-reference/reasons/list-reasons"},{"title":"Create a Reason","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons","href":"/api-reference/reasons/create-a-reason"},{"title":"Get a Reason","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons/{reasonId}","href":"/api-reference/reasons/get-a-reason"},{"title":"Delete a Reason","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/reasons/{reasonId}","href":"/api-reference/reasons/delete-a-reason"},{"title":"Update a Reason","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/reasons/{reasonId}","href":"/api-reference/reasons/update-a-reason"},{"title":"Archive a Reason","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/archive","href":"/api-reference/reasons/archive-a-reason"},{"title":"Create a cloud computer for a Reason","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/computers","href":"/api-reference/reasons/create-a-cloud-computer-for-a-reason"},{"title":"Delete a Reason's cloud computer","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/reasons/{reasonId}/computers/{computerId}","href":"/api-reference/reasons/delete-a-reasons-cloud-computer"},{"title":"Open a Reason's conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/conversation","href":"/api-reference/reasons/open-a-reasons-conversation"},{"title":"Make a Reason the main one","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/make-main","href":"/api-reference/reasons/make-a-reason-the-main-one"},{"title":"Merge a Reason into another","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/merge","href":"/api-reference/reasons/merge-a-reason-into-another"},{"title":"List a Reason's messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons/{reasonId}/messages","href":"/api-reference/reasons/list-a-reasons-messages"},{"title":"Message a Reason","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/messages","href":"/api-reference/reasons/message-a-reason"}]},{"group":"Loops","pages":[{"title":"List a Reason's Loops","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons/{reasonId}/loops","href":"/api-reference/loops/list-a-reasons-loops"},{"title":"Create a Loop","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/loops","href":"/api-reference/loops/create-a-loop"},{"title":"Retrieve a Loop","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}","href":"/api-reference/loops/retrieve-a-loop"},{"title":"Delete a Loop","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}","href":"/api-reference/loops/delete-a-loop"},{"title":"Update a Loop","deprecated":null,"version":null,"openapi":"/openapi.json patch /v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}","href":"/api-reference/loops/update-a-loop"},{"title":"Run a Loop now","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/reasons/{reasonId}/loops/{loopId}/run","href":"/api-reference/loops/run-a-loop-now"},{"title":"Send an event to a Loop","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/automations/{publicToken}","href":"/api-reference/loops/send-an-event-to-a-loop"},{"title":"Send an event to a Loop (key in the URL)","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/automations/{publicToken}/{key}","href":"/api-reference/loops/send-an-event-to-a-loop-key-in-the-url"}]},{"group":"Roles","pages":[{"title":"List role assignments (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/roles","href":"/api-reference/roles/list-role-assignments-retired"},{"title":"Set a role assignment (retired)","deprecated":true,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/roles","href":"/api-reference/roles/set-a-role-assignment-retired"},{"title":"Get the caller's roles","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/roles/me","href":"/api-reference/roles/get-the-callers-roles"},{"title":"Get a role assignment (retired)","deprecated":true,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/roles/{userId}","href":"/api-reference/roles/get-a-role-assignment-retired"}]},{"group":"Secrets","pages":[{"title":"List secret names","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/secrets","href":"/api-reference/secrets/list-secret-names"},{"title":"Create or update a secret","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/secrets","href":"/api-reference/secrets/create-or-update-a-secret"},{"title":"Create or update workspace secrets in a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/secrets/bulk","href":"/api-reference/secrets/create-or-update-workspace-secrets-in-a-batch"},{"title":"Delete a secret","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/secrets/{secretId}","href":"/api-reference/secrets/delete-a-secret"}]},{"group":"Settings","pages":[{"title":"List organization settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/settings","href":"/api-reference/settings/list-organization-settings"},{"title":"Get a settings namespace","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/settings/{namespace}","href":"/api-reference/settings/get-a-settings-namespace"},{"title":"Update a settings namespace","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/settings/{namespace}","href":"/api-reference/settings/update-a-settings-namespace"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/skills","href":"/api-reference/skills/list-skills"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/skills","href":"/api-reference/skills/create-a-skill"},{"title":"Retrieve a skill","deprecated":null,"version":null,"openapi":"/openapi.json get /v3/organizations/{orgId}/skills/{skillId}","href":"/api-reference/skills/retrieve-a-skill"},{"title":"Update a skill","deprecated":null,"version":null,"openapi":"/openapi.json put /v3/organizations/{orgId}/skills/{skillId}","href":"/api-reference/skills/update-a-skill"},{"title":"Delete a skill","deprecated":null,"version":null,"openapi":"/openapi.json delete /v3/organizations/{orgId}/skills/{skillId}","href":"/api-reference/skills/delete-a-skill"}]},{"group":"Transcription","pages":[{"title":"Transcribe a recording","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/transcribe","href":"/api-reference/transcription/transcribe-a-recording"}]},{"group":"Direct web","pages":[{"title":"Fetch public web content","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/web/fetch","href":"/api-reference/direct-web/fetch-public-web-content"},{"title":"Search the public web","deprecated":null,"version":null,"openapi":"/openapi.json post /v3/organizations/{orgId}/web/search","href":"/api-reference/direct-web/search-the-public-web"}]}]}]}]},"basePath":"","title":"Read your Device - Reason Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}