Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"agentsfleet","colors":{"primary":"#06695e","light":"#b8f0ce","dark":"#06695e"},"logo":{"light":"https://mintcdn.com/megam/hjP6HbP-ScNkci8i/logo/light.svg?fit=max\u0026auto=format\u0026n=hjP6HbP-ScNkci8i\u0026q=85\u0026s=fa8c530145772cd7349958eb570e5321","dark":"https://mintcdn.com/megam/hjP6HbP-ScNkci8i/logo/dark.svg?fit=max\u0026auto=format\u0026n=hjP6HbP-ScNkci8i\u0026q=85\u0026s=bbfcbdb03d47140f4066196ff216e4f1"},"favicon":"https://mintcdn.com/megam/hjP6HbP-ScNkci8i/favicon.svg?fit=max\u0026auto=format\u0026n=hjP6HbP-ScNkci8i\u0026q=85\u0026s=8798fa803cfc10cf32d3028256c9aaa9","appearance":{"default":"dark"},"background":{"color":{"light":"#f8f6f0","dark":"#151716"}},"navbar":{"links":[{"href":"/changelog","label":"Changelog"},{"href":"mailto:[email protected]?subject=Talk%20to%20us","label":"Talk to us"}],"primary":{"type":"button","label":"Get early access","href":"https://accounts.agentsfleet.net/waitlist"}},"footer":{"socials":{"github":"https://github.com/agentsfleet","discord":"https://discord.gg/H9hH2nqQjh"}},"fonts":{"heading":{"family":"Bricolage Grotesque","weight":600,"source":"fonts/BricolageGrotesque-Variable.woff2","format":"woff2"},"body":{"family":"Instrument Sans","weight":400,"source":"fonts/InstrumentSans-Variable.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":"vesper"},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://agentsfleet.net"},{"anchor":"GitHub","icon":"github","href":"https://github.com/agentsfleet/agentsfleet"},{"anchor":"Contributing","icon":"code-pull-request","href":"https://github.com/agentsfleet/agentsfleet#contributing"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"megam","hasAudioNarration":false,"actualSubdomain":"megam","customDomains":["docs.agentsfleet.net"],"gitSource":{"type":"github","owner":"agentsfleet","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae21e7253960a0748c10336","collectionId":"2192bcf0-f639-43af-a241-9f52e2f6d465","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae21e7253960a0748c10336"},"entitlements":{},"buildId":"6ae333fcf23a51dd552f8686","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":147},{"language":"default","tag":"Runner API","count":24},{"language":"default","tag":"Guides","count":23},{"language":"default","tag":"Fleet library","count":12},{"language":"default","tag":"Private setup chats","count":9},{"language":"default","tag":"Authentication","count":8},{"language":"default","tag":"Fleets","count":8},{"language":"default","tag":"Platform administration","count":7},{"language":"default","tag":"Runner administration","count":7},{"language":"default","tag":"Account management","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Instrument Sans\";src:url(/fonts/InstrumentSans-Variable.woff2) format(\"woff2\");font-weight:400 700;font-style:normal;font-display:swap}@font-face{font-family:\"Bricolage Grotesque\";src:url(/fonts/BricolageGrotesque-Variable.woff2) format(\"woff2\");font-weight:200 800;font-style:normal;font-display:swap}@font-face{font-family:\"Commit Mono\";src:url(/fonts/CommitMono-Medium.woff2) format(\"woff2\");font-weight:500;font-style:normal;font-display:swap}:root{--font-mono:\"Commit Mono\", ui-monospace, monospace;--docs-bg:#f8f6f0;--docs-text-primary:#14251f;--docs-text:#435d52;--docs-cta:#17211f;--docs-cta-text:#ffffff}.dark{--docs-bg:#151716;--docs-text-primary:#f2f0e9;--docs-text:#c0c5bc;--docs-cta:#b8f0ce;--docs-cta-text:#15221a}body{background-color:var(--docs-bg);color:var(--docs-text-primary)}#content-area :is(h1, h2, h3, h4, h5, h6){color:var(--docs-text-primary)}a[href=\"https://accounts.agentsfleet.net/waitlist\"][target=_blank]{background-color:var(--docs-cta);color:var(--docs-cta-text);border-radius:8px}a[href=\"https://accounts.agentsfleet.net/waitlist\"][target=_blank] *{color:inherit}a[href=\"https://accounts.agentsfleet.net/waitlist\"][target=_blank]>span{background-color:var(--docs-cta);border-radius:inherit}code,kbd,pre,samp{font-family:var(--font-mono)}#content-area :is(h2, h3, h4, h5, h6){font-family:\"Instrument Sans\",system-ui,sans-serif}#content-area :is(p, li){line-height:1.7;color:var(--docs-text)}#content{color:var(--docs-text);line-height:1.7}"}],"page":{"pagePath":"api-reference/fleet/read-a-runner","slug":"/api-reference/fleet/read-a-runner","pageMetadata":{"title":"Read a runner","description":"Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}","href":"/api-reference/fleet/read-a-runner","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a runner’s details, current work, and lifetime counters. Requires platform administrator access.\"\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":{"codeStyling":{"theme":"vesper"},"config":{},"pageMetadata":{"title":"Read a runner","description":"Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}","href":"/api-reference/fleet/read-a-runner","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Fleet"],"summary":"Read a runner","description":"Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.","operationId":"get_fleet_runner","parameters":["0371b58c-5ec7-4c8d-a3f1-2c106a1a2bb1"],"responses":{"200":"dfed4af2-bc3f-4695-b5d5-7078c8a316b1","400":"c36fda96-7efb-4fcb-9b81-404ce021b49a","401":"f6b06d21-91ed-4333-998f-f279b77a88d4","403":"efe36646-8f8d-46a6-8f16-0490893fa558","404":"f509497c-1a85-4c21-9db4-d5d11576efb6","429":"b399c5e1-dc31-493c-b5ca-14ebf10a1dff","500":"789c73a8-6dcf-4d99-a302-8199b7cb8f7a","503":"4b1a411d-ff13-49b4-9ea1-220f619f250e"},"security":["a4eefa41-e2d4-48b8-a9f1-0b6eb61ef924"],"method":"get","type":"path","servers":["8bb958dd-62c3-4bd5-998f-ac9847ab70cb"],"path":"/v1/fleets/runners/{runner_id}","baseUrlOptions":["https://api.agentsfleet.net"],"title":"Read a runner","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0371b58c-5ec7-4c8d-a3f1-2c106a1a2bb1":{"name":"runner_id","in":"path","description":"Runner identifier (version 7 universally unique identifier, or UUID).","required":true,"schema":{"type":"string","isRequired":true,"description":"Runner identifier (version 7 universally unique identifier, or UUID).","uniqueKey":"","typeLabel":"string"}}},"responses":{"dfed4af2-bc3f-4695-b5d5-7078c8a316b1":{"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"One runner with its live and lifetime counters.","required":["active_lease_count","active_fleet_count","leases_acquired","leases_succeeded","leases_failed","leases_expired","id","host_id","sandbox_tier","status","liveness","labels","last_seen_at","created_at","assigned_policy","degraded"],"properties":{"assigned_policy":{"type":"object","description":"Policy currently assigned to the host.","required":["sandbox_tier","network_policy","registry_allowlist","worker_count","extra_binds"],"properties":{"extra_binds":{"type":"array","items":{"type":"object","description":"One host path bound into every lease's sandbox, in addition to the baseline.\n\nAn operator may ADD a path a host needs; never remove or re-mode one the\nsandbox depends on.","required":["path","mode","note"],"properties":{"mode":{"type":"string","description":"Whether the bind is writable.","enum":["read_only","read_write"],"isRequired":true,"uniqueKey":"assigned_policy.extra_binds.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"note":{"type":"string","description":"Operator note explaining why the bind exists.","isRequired":true,"uniqueKey":"assigned_policy.extra_binds.items.[INDEX].note","typeLabel":"string"},"path":{"type":"string","description":"Host path to bind.","isRequired":true,"uniqueKey":"assigned_policy.extra_binds.items.[INDEX].path","typeLabel":"string"}},"uniqueKey":"assigned_policy.extra_binds.items.[INDEX]","typeLabel":"object"},"description":"Extra host paths bound into every lease's sandbox.","isRequired":true,"uniqueKey":"assigned_policy.extra_binds","typeLabel":"object[]"},"network_policy":{"type":"string","description":"Outgoing network access policy to apply.","enum":["allow_all","deny_all_egress","allow_list_egress"],"isRequired":true,"uniqueKey":"assigned_policy.network_policy","typeLabel":"enum\u003cstring>"},"registry_allowlist":{"type":"array","items":{"type":"string","uniqueKey":"assigned_policy.registry_allowlist.items.[INDEX]","typeLabel":"string"},"description":"Default package registries added to each assignment's allowed network hosts. An empty\nlist uses the runner's defaults.","isRequired":true,"uniqueKey":"assigned_policy.registry_allowlist","typeLabel":"string[]"},"sandbox_tier":{"type":"string","description":"Isolation strength to apply.","enum":["landlock_full","container_nested","dev_none"],"isRequired":true,"uniqueKey":"assigned_policy.sandbox_tier","typeLabel":"enum\u003cstring>"},"worker_count":{"type":"integer","format":"int32","description":"Concurrent workers the runner may start. Clamped on both sides.","minimum":0,"isRequired":true,"uniqueKey":"assigned_policy.worker_count","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"assigned_policy","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"Enrolment instant.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"degraded":{"type":"boolean","description":"Whether the assignment exceeds the reported capability.","isRequired":true,"uniqueKey":"degraded","typeLabel":"boolean"},"host_id":{"type":"string","description":"Stable host identity supplied at enrolment.","isRequired":true,"uniqueKey":"host_id","typeLabel":"string"},"id":{"type":"string","description":"Canonical runner identifier.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"labels":{"type":"array","items":{"type":"string","uniqueKey":"labels.items.[INDEX]","typeLabel":"string"},"description":"Placement labels.","isRequired":true,"uniqueKey":"labels","typeLabel":"string[]"},"last_seen_at":{"type":"string","format":"date-time","description":"Last heartbeat instant.","isRequired":true,"uniqueKey":"last_seen_at","typeLabel":"string\u003cdate-time>"},"liveness":{"type":"string","description":"Runtime state derived from heartbeat and leases.","enum":["registered","busy","online","offline"],"isRequired":true,"uniqueKey":"liveness","typeLabel":"enum\u003cstring>"},"sandbox_tier":{"type":"string","description":"Assigned isolation tier spelling.","isRequired":true,"uniqueKey":"sandbox_tier","typeLabel":"string"},"status":{"type":"string","description":"Operator-controlled admission state.","enum":["active","cordoned","draining","drained","revoked"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"active_fleet_count":{"type":"integer","format":"int64","description":"Fleets represented by live leases.","isRequired":true,"uniqueKey":"active_fleet_count","typeLabel":"integer\u003cint64>"},"active_lease_count":{"type":"integer","format":"int64","description":"Live leases currently held.","isRequired":true,"uniqueKey":"active_lease_count","typeLabel":"integer\u003cint64>"},"leases_acquired":{"type":"integer","format":"int64","description":"Lifetime acquired count.","isRequired":true,"uniqueKey":"leases_acquired","typeLabel":"integer\u003cint64>"},"leases_expired":{"type":"integer","format":"int64","description":"Lifetime expired count.","isRequired":true,"uniqueKey":"leases_expired","typeLabel":"integer\u003cint64>"},"leases_failed":{"type":"integer","format":"int64","description":"Lifetime failed count.","isRequired":true,"uniqueKey":"leases_failed","typeLabel":"integer\u003cint64>"},"leases_succeeded":{"type":"integer","format":"int64","description":"Lifetime successful count.","isRequired":true,"uniqueKey":"leases_succeeded","typeLabel":"integer\u003cint64>"},"achievable":{"oneOf":[{"type":"object","description":"Capability report most recently supplied by the host.","required":["landlock","seccomp","cgroup_controllers","bubblewrap","egress_enforcement"],"properties":{"bubblewrap":{"type":"boolean","description":"The sandbox launcher is available.","isRequired":true,"uniqueKey":"achievable.oneOf.0.bubblewrap","typeLabel":"boolean"},"cgroup_controllers":{"type":"array","items":{"type":"string","uniqueKey":"achievable.oneOf.0.cgroup_controllers.items.[INDEX]","typeLabel":"string"},"description":"Controllers present in the delegated cgroup's subtree control.","isRequired":true,"uniqueKey":"achievable.oneOf.0.cgroup_controllers","typeLabel":"string[]"},"egress_enforcement":{"type":"boolean","description":"Whether the operating system can restrict outgoing network access to allowed hosts.","isRequired":true,"uniqueKey":"achievable.oneOf.0.egress_enforcement","typeLabel":"boolean"},"landlock":{"type":"boolean","description":"Filesystem isolation is available.","isRequired":true,"uniqueKey":"achievable.oneOf.0.landlock","typeLabel":"boolean"},"seccomp":{"type":"boolean","description":"System-call filtering is available.","isRequired":true,"uniqueKey":"achievable.oneOf.0.seccomp","typeLabel":"boolean"},"build_id":{"oneOf":[{"type":"string","description":"Source digest compiled into the reporting runner; absent for an unbound build.","uniqueKey":"achievable.oneOf.0.build_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Source digest compiled into the reporting runner; absent for an unbound build.","uniqueKey":"achievable.oneOf.0.build_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"achievable.oneOf.0.build_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"achievable.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"achievable.oneOf.1","typeLabel":"null"}],"uniqueKey":"achievable","typeLabel":"object | null"},"degraded_reason":{"oneOf":[{"type":"string","description":"Stored explanation for a degraded verdict.","uniqueKey":"degraded_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stored explanation for a degraded verdict.","uniqueKey":"degraded_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"degraded_reason","typeLabel":"string | null"},"selftest":{"oneOf":[{"type":"object","description":"Latest complete self-test report.","required":["checks","all_ok","sandbox_tier","network_policy"],"properties":{"all_ok":{"type":"boolean","description":"Whether every check passed.","isRequired":true,"uniqueKey":"selftest.oneOf.0.all_ok","typeLabel":"boolean"},"checks":{"type":"array","items":{"type":"object","description":"One self-test check's verdict.\n\n`detail` is prose even when `ok`: every passing check carries a line, and a\nwhitespace-free cause reads to an operator as a leaked internal identifier.","required":["name","ok","detail"],"properties":{"detail":{"type":"string","description":"Why, in prose.","isRequired":true,"uniqueKey":"selftest.oneOf.0.checks.items.[INDEX].detail","typeLabel":"string"},"name":{"type":"string","description":"What was checked.","isRequired":true,"uniqueKey":"selftest.oneOf.0.checks.items.[INDEX].name","typeLabel":"string"},"ok":{"type":"boolean","description":"Whether it passed.","isRequired":true,"uniqueKey":"selftest.oneOf.0.checks.items.[INDEX].ok","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"selftest.oneOf.0.checks.items.[INDEX]","typeLabel":"object"},"description":"Every check the probe ran.","isRequired":true,"uniqueKey":"selftest.oneOf.0.checks","typeLabel":"object[]"},"network_policy":{"type":"string","description":"Outgoing network access policy in effect during the self-test.","isRequired":true,"uniqueKey":"selftest.oneOf.0.network_policy","typeLabel":"string"},"sandbox_tier":{"type":"string","description":"The tier in force when the probe ran.","isRequired":true,"uniqueKey":"selftest.oneOf.0.sandbox_tier","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"selftest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"selftest.oneOf.1","typeLabel":"null"}],"uniqueKey":"selftest","typeLabel":"object | null"},"selftest_completed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Latest self-test completion instant.","uniqueKey":"selftest_completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Latest self-test completion instant.","uniqueKey":"selftest_completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"selftest_completed_at","typeLabel":"string\u003cdate-time> | null"},"selftest_requested_at":{"oneOf":[{"type":"string","format":"date-time","description":"Outstanding self-test request instant.","uniqueKey":"selftest_requested_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Outstanding self-test request instant.","uniqueKey":"selftest_requested_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"selftest_requested_at","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"assigned_policy":{"extra_binds":[{"mode":"read_only","note":"\u003cstring>","path":"\u003cstring>"}],"network_policy":"allow_all","registry_allowlist":["\u003cstring>"],"sandbox_tier":"landlock_full","worker_count":1},"created_at":"2023-11-07T05:31:56Z","degraded":true,"host_id":"\u003cstring>","id":"\u003cstring>","labels":["\u003cstring>"],"last_seen_at":"2023-11-07T05:31:56Z","liveness":"registered","sandbox_tier":"\u003cstring>","status":"active","active_fleet_count":123,"active_lease_count":123,"leases_acquired":123,"leases_expired":123,"leases_failed":123,"leases_succeeded":123,"achievable":{"bubblewrap":true,"cgroup_controllers":["\u003cstring>"],"egress_enforcement":true,"landlock":true,"seccomp":true,"build_id":"\u003cstring>"},"degraded_reason":"\u003cstring>","selftest":{"all_ok":true,"checks":[{"detail":"\u003cstring>","name":"\u003cstring>","ok":true}],"network_policy":"\u003cstring>","sandbox_tier":"\u003cstring>"},"selftest_completed_at":"2023-11-07T05:31:56Z","selftest_requested_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"c36fda96-7efb-4fcb-9b81-404ce021b49a":{"description":"The request is invalid","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f6b06d21-91ed-4333-998f-f279b77a88d4":{"description":"Authentication is missing, invalid, or not accepted by this endpoint","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"efe36646-8f8d-46a6-8f16-0490893fa558":{"description":"You do not have permission for this action","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f509497c-1a85-4c21-9db4-d5d11576efb6":{"description":"The resource was not found or is not accessible to you","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b399c5e1-dc31-493c-b5ca-14ebf10a1dff":{"description":"A request or capacity limit has been reached","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"789c73a8-6dcf-4d99-a302-8199b7cb8f7a":{"description":"An internal server error occurred","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"4b1a411d-ff13-49b4-9ea1-220f619f250e":{"description":"A required service is unavailable","content":{"application/problem+json":{"schema":{"type":"object","description":"The body every refusal carries, under `application/problem+json`.","required":["docs_uri","title","detail","error_code","request_id"],"properties":{"detail":{"type":"string","description":"One sentence on what was refused and why.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"docs_uri":{"type":"string","description":"Where the error code is documented.","isRequired":true,"uniqueKey":"docs_uri","typeLabel":"string"},"error_code":{"type":"string","description":"The registry code, stable across releases.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"request_id":{"type":"string","description":"The request this refusal answers, for support.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"title":{"type":"string","description":"A short name for the refusal, safe to show a person.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"action_id":{"oneOf":[{"type":"string","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the action the gate held.","uniqueKey":"action_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"action_id","typeLabel":"string | null"},"current_state":{"oneOf":[{"type":"string","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 409 only: the state that forbade the transition.","uniqueKey":"current_state.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_state","typeLabel":"string | null"},"etag":{"oneOf":[{"type":"string","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.0","typeLabel":"string"},{"type":"null","description":"On a 412 only: the resource's current entity tag, to refetch and retry.","uniqueKey":"etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"etag","typeLabel":"string | null"},"gate_id":{"oneOf":[{"type":"string","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"On an answered approval gate's 409 only: the gate that was answered.","uniqueKey":"gate_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"gate_id","typeLabel":"string | null"},"outcome":{"oneOf":[{"type":"string","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: the answer that stands.","uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"uniqueKey":"outcome","typeLabel":"string | null"},"resolved_at":{"oneOf":[{"type":"string","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"On that 409 only: when the standing answer was given.","uniqueKey":"resolved_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_at","typeLabel":"string\u003cdate-time> | null"},"resolved_by":{"oneOf":[{"type":"string","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"On that 409 only: who gave it.","uniqueKey":"resolved_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resolved_by","typeLabel":"string | null"},"user_message":{"oneOf":[{"type":"string","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A curated sentence for end users, where the code has one.","uniqueKey":"user_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_message","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","docs_uri":"\u003cstring>","error_code":"\u003cstring>","request_id":"\u003cstring>","title":"\u003cstring>","action_id":"\u003cstring>","current_state":"\u003cstring>","etag":"\u003cstring>","gate_id":"\u003cstring>","outcome":"\u003cstring>","resolved_at":"2023-11-07T05:31:56Z","resolved_by":"\u003cstring>","user_message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a4eefa41-e2d4-48b8-a9f1-0b6eb61ef924":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Send a dashboard session token, an account API key (`agt_t`), or a command-line credential (`afc_`) as a Bearer token. Each endpoint lists accepted credential types.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"8bb958dd-62c3-4bd5-998f-ac9847ab70cb":{"url":"https://api.agentsfleet.net","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Send a dashboard session token, an account API key (`agt_t`), or a command-line credential (`afc_`) as a Bearer token. Each endpoint lists accepted credential types.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send a dashboard session token, an account API key (`agt_t`), or a command-line credential (`afc_`) as a Bearer token. Each endpoint lists accepted credential types.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json"},"subdomain":"megam","siteName":"agentsfleet","title":"Read a runner - agentsfleet","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T16:11:30.153Z","originalFileLocation":"api-reference/fleet/read-a-runner.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=\"dark\"}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 runner\u0026#x27;s details, current work, and lifetime counters. Requires platform administrator access.\">\u003cmeta data-mint-head name=\"application-name\" content=\"agentsfleet\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read a runner - agentsfleet\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a runner\u0026#x27;s details, current work, and lifetime counters. Requires platform administrator access.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"agentsfleet\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://megam.mintlify.app/_mintlify/api/og/v2?division=Runner+administration\u0026amp;title=Read+a+runner\u0026amp;description=Returns+a+runner%27s+details%2C+current+work%2C+and+lifetime+counters.+Requires+platform+administrator+access.\u0026amp;theme=c1afddfaf3593c4dee1e1403\u0026amp;signature=801d545c2628ccbc3e1fa601b2461aab075a3a62f5a8859e9d9b198d00d4b50c\">\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 a runner - agentsfleet\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a runner\u0026#x27;s details, current work, and lifetime counters. Requires platform administrator access.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://megam.mintlify.app/_mintlify/api/og/v2?division=Runner+administration\u0026amp;title=Read+a+runner\u0026amp;description=Returns+a+runner%27s+details%2C+current+work%2C+and+lifetime+counters.+Requires+platform+administrator+access.\u0026amp;theme=c1afddfaf3593c4dee1e1403\u0026amp;signature=801d545c2628ccbc3e1fa601b2461aab075a3a62f5a8859e9d9b198d00d4b50c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/megam/rqiTv6wHds1vkBWk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"agentsfleet\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#06695e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/fleet/read-a-runner.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agentsfleet.net/#organization\",\"name\":\"agentsfleet\",\"url\":\"https://docs.agentsfleet.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/megam/hjP6HbP-ScNkci8i/logo/light.svg?fit=max\u0026auto=format\u0026n=hjP6HbP-ScNkci8i\u0026q=85\u0026s=fa8c530145772cd7349958eb570e5321\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agentsfleet.net#website\",\"name\":\"agentsfleet\",\"url\":\"https://docs.agentsfleet.net\",\"publisher\":{\"@id\":\"https://docs.agentsfleet.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner#webpage\",\"url\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner\",\"name\":\"Read a runner\",\"description\":\"Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.\",\"dateModified\":\"2026-10-28T16:11:30.153Z\",\"isPartOf\":{\"@id\":\"https://docs.agentsfleet.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Runner administration\",\"item\":\"https://docs.agentsfleet.net/api-reference/fleet/register-a-runner\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read a runner\",\"item\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner#apireference\",\"headline\":\"Read a runner\",\"name\":\"Read a runner\",\"description\":\"Returns a runner's details, current work, and lifetime counters. Requires platform administrator access.\",\"url\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentsfleet.net/api-reference/fleet/read-a-runner#webpage\"},\"dateModified\":\"2026-10-28T16:11:30.153Z\",\"publisher\":{\"@id\":\"https://docs.agentsfleet.net/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agentsfleet.net#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"agentsfleet\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"agentsfleet","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://agentsfleet.net"},{"anchor":"GitHub","icon":"github","href":"https://github.com/agentsfleet/agentsfleet"},{"anchor":"Contributing","icon":"code-pull-request","href":"https://github.com/agentsfleet/agentsfleet#contributing"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"CLI reference","pages":[{"title":"CLI reference","href":"/cli/install"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API introduction","href":"/api-reference/introduction"},{"title":"Error codes","href":"/api-reference/error-codes"},{"title":"API scopes","href":"/api-reference/scopes"}]},{"group":"Health","pages":[{"title":"Liveness check","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /healthz","href":"/api-reference/health/liveness-check"},{"title":"Readiness probe","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /readyz","href":"/api-reference/health/readiness-probe"}]},{"group":"Authentication","pages":[{"title":"Start a command-line login session","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/auth/sessions","href":"/api-reference/authentication/start-a-command-line-login-session"},{"title":"Read a sign-in session","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/auth/sessions/{session_id}","href":"/api-reference/authentication/read-a-sign-in-session"},{"title":"Approve a sign-in session","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/auth/sessions/{session_id}/approve","href":"/api-reference/authentication/approve-a-sign-in-session"},{"title":"Verify a sign-in session","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/auth/sessions/{session_id}/verify","href":"/api-reference/authentication/verify-a-sign-in-session"},{"title":"Cancel your unfinished sign-in sessions","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/auth/sessions","href":"/api-reference/authentication/cancel-your-unfinished-sign-in-sessions"},{"title":"Receive a Clerk account event","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/auth/identity-events/clerk","href":"/api-reference/auth-identity-events/receive-a-clerk-account-event"},{"title":"Create a command-line credential","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/cli-credentials","href":"/api-reference/cli-credentials/create-a-command-line-credential"},{"title":"Revoke a command-line credential","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/cli-credentials/{id}","href":"/api-reference/cli-credentials/revoke-a-command-line-credential"}]},{"group":"API keys","pages":[{"title":"List account API keys","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/api-keys","href":"/api-reference/api-keys/list-account-api-keys"},{"title":"Create an account API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/api-keys","href":"/api-reference/api-keys/create-an-account-api-key"},{"title":"Revoke an account API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-account-api-key"},{"title":"Delete a revoked account API key","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/api-keys/{id}","href":"/api-reference/api-keys/delete-a-revoked-account-api-key"}]},{"group":"Users","pages":[{"title":"Read the current user","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/users/me","href":"/api-reference/users/read-the-current-user"},{"title":"List invites waiting for you","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/users/me/invites","href":"/api-reference/invites/list-invites-waiting-for-you"},{"title":"Accept an invite","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/users/me/invites/{invite_id}/accept","href":"/api-reference/invites/accept-an-invite"}]},{"group":"Account management","pages":[{"title":"List your workspaces","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/workspaces","href":"/api-reference/workspaces/list-your-workspaces"},{"title":"List the people in your account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/members","href":"/api-reference/members/list-the-people-in-your-account"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/tenants/me/members/{user_id}","href":"/api-reference/members/remove-a-member"},{"title":"List pending invites","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/invites","href":"/api-reference/invites/list-pending-invites"},{"title":"Invite a person into your account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/tenants/me/invites","href":"/api-reference/invites/invite-a-person-into-your-account"},{"title":"Send an invite's email again","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/tenants/me/invites/{invite_id}/send","href":"/api-reference/invites/send-an-invites-email-again"},{"title":"Revoke an invite","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/tenants/me/invites/{invite_id}","href":"/api-reference/invites/revoke-an-invite"}]},{"group":"Model provider credentials","pages":[{"title":"Read account model provider settings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/provider","href":"/api-reference/tenant/read-account-model-provider-settings"},{"title":"Set account model provider","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json put /v1/tenants/me/provider","href":"/api-reference/tenant/set-account-model-provider"},{"title":"Reset the account model provider","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/tenants/me/provider","href":"/api-reference/tenant/reset-the-account-model-provider"}]},{"group":"Balance and usage","pages":[{"title":"Read account balance","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/billing","href":"/api-reference/billing/read-account-balance"},{"title":"List account charges","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/billing/charges","href":"/api-reference/billing/list-account-charges"},{"title":"Read settled usage report","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/billing/reports/current","href":"/api-reference/billing/read-settled-usage-report"},{"title":"List an activity's settled charges","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/billing/activities/{activity_id}/charges","href":"/api-reference/billing/list-an-activitys-settled-charges"}]},{"group":"Account models","pages":[{"title":"List configured account models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/tenants/me/models","href":"/api-reference/tenant/list-configured-account-models"},{"title":"Register a model entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/tenants/me/models","href":"/api-reference/tenant/register-a-model-entry"},{"title":"Change the model on an entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/tenants/me/models/{id}","href":"/api-reference/tenant/change-the-model-on-an-entry"},{"title":"Remove a model entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/tenants/me/models/{id}","href":"/api-reference/tenant/remove-a-model-entry"}]},{"group":"Runner administration","pages":[{"title":"Register a runner","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners","href":"/api-reference/fleet/register-a-runner"},{"title":"List runners","description":"Lists runners newest first. Requires platform administrator access. Each item includes its current connection status, without authentication state or token hashes. Use `next_cursor` to continue.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners","href":"/api-reference/fleet/list-runners"},{"title":"Read a runner","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}","href":"/api-reference/fleet/read-a-runner"},{"title":"Manage a runner","description":"Requires platform administrator access. Send either `action` or an edit containing `assigned_policy`, `labels`, or both. Both edits succeed together or neither changes.\n\nActions are `cordon`, `drain`, `revoke`, `rotate`, and `self_test`. Revocation is permanent. `rotate` returns a replacement `runner_token` once; save it and update the host. `self_test` queues a sandbox check; the runner receives it on its next heartbeat and reports later. The response confirms the request, not the result. Revoked runners return 409 `UZ-RUN-018`.\n\nPolicy changes reach the runner on its next heartbeat. Repeating the current policy has no effect; revoked runners return 400. Labels replace the entire set, using enrollment limits. Duplicates are removed in their original order; an empty list clears labels. Revoked runners' labels remain editable. The response includes labels when supplied.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/fleets/runners/{runner_id}","href":"/api-reference/fleet/manage-a-runner"},{"title":"Delete a revoked runner","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/fleets/runners/{runner_id}","href":"/api-reference/fleet/delete-a-revoked-runner"},{"title":"List a runner's work assignments","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}/leases","href":"/api-reference/fleet/list-a-runners-work-assignments"},{"title":"List runner activity","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/fleets/runners/{runner_id}/events","href":"/api-reference/fleet/list-runner-activity"}]},{"group":"Runner API","pages":[{"title":"Read this runner's status","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/runners/me","href":"/api-reference/runners/read-this-runners-status"},{"title":"Send a heartbeat and receive settings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/heartbeats","href":"/api-reference/runners/send-a-heartbeat-and-receive-settings"},{"title":"Request the next work assignment","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases","href":"/api-reference/runners/request-the-next-work-assignment"},{"title":"Extend a live lease","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/renew","href":"/api-reference/runners/extend-a-live-lease"},{"title":"Publish live activity","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/activity","href":"/api-reference/runners/publish-live-activity"},{"title":"Save full tool call output","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/tool-calls","href":"/api-reference/runners/save-full-tool-call-output"},{"title":"Post a message to the event's thread","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/messages","href":"/api-reference/runners/post-a-message-to-the-events-thread"},{"title":"Load private run working notes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/runners/me/leases/{lease_id}/context-checkpoints/{branch_id}","href":"/api-reference/runners/load-private-run-working-notes"},{"title":"Replace private run working notes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json put /v1/runners/me/leases/{lease_id}/context-checkpoints/{branch_id}","href":"/api-reference/runners/replace-private-run-working-notes"},{"title":"List the running fleet's schedules","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/runners/me/leases/{lease_id}/schedules","href":"/api-reference/schedules/list-the-running-fleets-schedules"},{"title":"Create a schedule for the running fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/schedules","href":"/api-reference/schedules/create-a-schedule-for-the-running-fleet"},{"title":"Change a schedule the fleet made","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/runners/me/leases/{lease_id}/schedules/{schedule_id}","href":"/api-reference/schedules/change-a-schedule-the-fleet-made"},{"title":"Delete a schedule the fleet made","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/runners/me/leases/{lease_id}/schedules/{schedule_id}","href":"/api-reference/schedules/delete-a-schedule-the-fleet-made"},{"title":"List a schedule's runs","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/runners/me/leases/{lease_id}/schedules/{schedule_id}/runs","href":"/api-reference/schedules/list-a-schedules-runs"},{"title":"Run a schedule now","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/leases/{lease_id}/schedules/{schedule_id}/runs","href":"/api-reference/schedules/run-a-schedule-now"},{"title":"Report the result of one run","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/reports","href":"/api-reference/runners/report-the-result-of-one-run"},{"title":"Create a tool credential","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/credentials/mint","href":"/api-reference/runners/create-a-tool-credential"},{"title":"Load what a fleet remembers","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/runners/me/memory/{fleet_id}","href":"/api-reference/memory/load-what-a-fleet-remembers"},{"title":"Capture what a fleet learned","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/memory/{fleet_id}","href":"/api-reference/memory/capture-what-a-fleet-learned"},{"title":"Search what a fleet remembers","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/memory/{fleet_id}/recall","href":"/api-reference/memory/search-what-a-fleet-remembers"},{"title":"Renew a private setup assignment","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/authoring-leases/{lease_id}/renew","href":"/api-reference/runners/renew-a-private-setup-assignment"},{"title":"Send private setup progress","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/authoring-leases/{lease_id}/activity","href":"/api-reference/runners/send-private-setup-progress"},{"title":"Report private setup usage and outcome","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/authoring-leases/{lease_id}/reports","href":"/api-reference/runners/report-private-setup-usage-and-outcome"},{"title":"Call the model for private setup","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/runners/me/authoring-leases/{lease_id}/model-calls","href":"/api-reference/runners/call-the-model-for-private-setup"}]},{"group":"Model catalog","pages":[{"title":"List available models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/models","href":"/api-reference/model-library/list-available-models"}]},{"group":"Workspaces","pages":[{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"List who can work in a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/members","href":"/api-reference/members/list-who-can-work-in-a-workspace"},{"title":"List workspace event history","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/events","href":"/api-reference/workspaces/list-workspace-event-history"},{"title":"Stream live activity for a whole workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/events/stream","href":"/api-reference/workspaces/stream-live-activity-for-a-whole-workspace"},{"title":"Read the workspace's onboarding checklist state","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/onboarding","href":"/api-reference/workspaces/read-the-workspaces-onboarding-checklist-state"},{"title":"List workspace model choices","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/models","href":"/api-reference/drafts/list-workspace-model-choices"}]},{"group":"Private setup chats","pages":[{"title":"List your private setup chats","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/drafts","href":"/api-reference/drafts/list-your-private-setup-chats"},{"title":"Start a private setup chat","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/drafts","href":"/api-reference/drafts/start-a-private-setup-chat"},{"title":"Read your private setup chat","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/drafts/{draft_id}","href":"/api-reference/drafts/read-your-private-setup-chat"},{"title":"Edit an idle private setup chat","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/workspaces/{workspace_id}/drafts/{draft_id}","href":"/api-reference/drafts/edit-an-idle-private-setup-chat"},{"title":"Delete your private setup chat","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/drafts/{draft_id}","href":"/api-reference/drafts/delete-your-private-setup-chat"},{"title":"Read your private setup messages","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/drafts/{draft_id}/messages","href":"/api-reference/drafts/read-your-private-setup-messages"},{"title":"Send a private setup message","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/drafts/{draft_id}/messages","href":"/api-reference/drafts/send-a-private-setup-message"},{"title":"Stop private setup through a message","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/drafts/{draft_id}/cancellations","href":"/api-reference/drafts/stop-private-setup-through-a-message"},{"title":"Stream your private setup progress","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/drafts/{draft_id}/events/stream","href":"/api-reference/drafts/stream-your-private-setup-progress"}]},{"group":"Workspace preferences","pages":[{"title":"Write one dashboard preference","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json put /v1/workspaces/{workspace_id}/preferences/{pref_key}","href":"/api-reference/workspaces/write-one-dashboard-preference"}]},{"group":"Secrets","pages":[{"title":"List secrets stored for a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/secrets","href":"/api-reference/secrets/list-secrets-stored-for-a-workspace"},{"title":"Store a workspace secret","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/secrets","href":"/api-reference/secrets/store-a-workspace-secret"},{"title":"Replace a secret's stored body","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json put /v1/workspaces/{workspace_id}/secrets/{name}","href":"/api-reference/secrets/replace-a-secrets-stored-body"},{"title":"Delete a secret from the workspace vault","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/secrets/{name}","href":"/api-reference/secrets/delete-a-secret-from-the-workspace-vault"}]},{"group":"Connectors","pages":[{"title":"List connectors for a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/connectors","href":"/api-reference/connectors/list-connectors-for-a-workspace"},{"title":"Get a provider connection URL","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/connectors/{provider}/connect","href":"/api-reference/connectors/get-a-provider-connection-url"},{"title":"Read a connector status","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/connectors/{provider}","href":"/api-reference/connectors/read-a-connector-status"},{"title":"Disconnect a provider from a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/connectors/{provider}","href":"/api-reference/connectors/disconnect-a-provider-from-a-workspace"},{"title":"Complete a provider connection","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/connectors/{provider}/callback","href":"/api-reference/connectors/complete-a-provider-connection"},{"title":"Receive Slack events","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/connectors/{provider}/events","href":"/api-reference/connectors/receive-slack-events"}]},{"group":"Approvals","pages":[{"title":"List workspace approval requests","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/approvals","href":"/api-reference/approvals/list-workspace-approval-requests"},{"title":"Read an approval request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/approvals/{gate_id}","href":"/api-reference/approvals/read-an-approval-request"},{"title":"Approve or reject a pending request","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/approvals/{gate_id}/{decision}","href":"/api-reference/approvals/approve-or-reject-a-pending-request"}]},{"group":"Fleets","pages":[{"title":"List fleets in a workspace","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets","href":"/api-reference/fleets/list-fleets-in-a-workspace"},{"title":"Save a reviewed fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleets","href":"/api-reference/fleets/save-a-reviewed-fleet"},{"title":"Read fleet setup and progress","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}","href":"/api-reference/fleets/read-fleet-setup-and-progress"},{"title":"Read your fleet editor context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/authoring-context","href":"/api-reference/fleets/read-your-fleet-editor-context"},{"title":"Change fleet lifecycle or name","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/workspaces/{workspace_id}/fleets/{fleet_id}","href":"/api-reference/fleets/change-fleet-lifecycle-or-name"},{"title":"Permanently delete a fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/fleets/{fleet_id}","href":"/api-reference/fleets/permanently-delete-a-fleet"},{"title":"Apply a reviewed fleet improvement","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleets/{fleet_id}/revisions","href":"/api-reference/fleets/apply-a-reviewed-fleet-improvement"},{"title":"Set who reads and publishes shared memory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/workspaces/{workspace_id}/fleets/{fleet_id}/memory-access","href":"/api-reference/memory/set-who-reads-and-publishes-shared-memory"},{"title":"Read your fleet editor context","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/authoring-context","href":"/api-reference/fleets/read-your-fleet-editor-context"}]},{"group":"Fleet library","pages":[{"title":"List available Library entries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleet-libraries","href":"/api-reference/fleet-library/list-available-library-entries"},{"title":"Publish a chat candidate to Library","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleet-libraries","href":"/api-reference/fleet-library/publish-a-chat-candidate-to-library"},{"title":"List owned Library entries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleet-libraries/owned","href":"/api-reference/fleet-library/list-owned-library-entries"},{"title":"Inspect a Library revision","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleet-libraries/{library_id}","href":"/api-reference/fleet-library/inspect-a-library-revision"},{"title":"Delete an owned Library entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/fleet-libraries/{library_id}","href":"/api-reference/fleet-library/delete-an-owned-library-entry"},{"title":"List immutable Library revisions","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleet-libraries/{library_id}/revisions","href":"/api-reference/fleet-library/list-immutable-library-revisions"},{"title":"Publish a revision to an owned Library","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleet-libraries/{library_id}/revisions","href":"/api-reference/fleet-library/publish-a-revision-to-an-owned-library"},{"title":"Inspect an immutable Library revision","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleet-libraries/{library_id}/revisions/{revision_id}","href":"/api-reference/fleet-library/inspect-an-immutable-library-revision"},{"title":"List staged and published native platform entries","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/admin/fleet-libraries","href":"/api-reference/fleet-library/list-staged-and-published-native-platform-entries"},{"title":"Stage a private chat candidate in the platform Library","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/admin/fleet-libraries","href":"/api-reference/fleet-library/stage-a-private-chat-candidate-in-the-platform-library"},{"title":"Curate, publish or withdraw native platform setup","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/admin/fleet-libraries/{id}","href":"/api-reference/fleet-library/curate-publish-or-withdraw-native-platform-setup"},{"title":"Delete a withdrawn native platform entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/admin/fleet-libraries/{id}","href":"/api-reference/fleet-library/delete-a-withdrawn-native-platform-entry"}]},{"group":"Fleet messages","pages":[{"title":"List a fleet's chat thread with bodies","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/messages","href":"/api-reference/fleets/list-a-fleets-chat-thread-with-bodies"},{"title":"Post a chat message to a fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleets/{fleet_id}/messages","href":"/api-reference/fleets/post-a-chat-message-to-a-fleet"}]},{"group":"Fleet memories","pages":[{"title":"List or search memory entries for a fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/memories","href":"/api-reference/memory/list-or-search-memory-entries-for-a-fleet"},{"title":"Forget a fleet memory entry","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/fleets/{fleet_id}/memories/{key}","href":"/api-reference/memory/forget-a-fleet-memory-entry"}]},{"group":"Fleet schedules","pages":[{"title":"List hosted schedules","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules","href":"/api-reference/schedules/list-hosted-schedules"},{"title":"Create a hosted schedule","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules","href":"/api-reference/schedules/create-a-hosted-schedule"},{"title":"Get a hosted schedule","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules/{schedule_id}","href":"/api-reference/schedules/get-a-hosted-schedule"},{"title":"Update a hosted schedule","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules/{schedule_id}","href":"/api-reference/schedules/update-a-hosted-schedule"},{"title":"Delete a hosted schedule","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules/{schedule_id}","href":"/api-reference/schedules/delete-a-hosted-schedule"},{"title":"Sync a hosted schedule","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/workspaces/{workspace_id}/fleets/{fleet_id}/schedules/{schedule_id}/sync","href":"/api-reference/schedules/sync-a-hosted-schedule"},{"title":"Receive a scheduled fire","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/ingress/qstash/schedules","href":"/api-reference/schedules/receive-a-scheduled-fire"}]},{"group":"Fleet events","pages":[{"title":"List a fleet's event history","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/events","href":"/api-reference/fleets/list-a-fleets-event-history"},{"title":"Read one fleet event","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/events/{event_id}","href":"/api-reference/fleets/read-one-fleet-event"},{"title":"Read one tool call in full","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/events/{event_id}/tool-calls/{call_id}","href":"/api-reference/fleets/read-one-tool-call-in-full"},{"title":"Stream live fleet activity","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/events/stream","href":"/api-reference/fleets/stream-live-fleet-activity"}]},{"group":"Integration grants","pages":[{"title":"List integration grants for a fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/integration-grants","href":"/api-reference/integration-grants/list-integration-grants-for-a-fleet"},{"title":"Revoke an integration grant","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/workspaces/{workspace_id}/fleets/{fleet_id}/integration-grants/{grant_id}","href":"/api-reference/integration-grants/revoke-an-integration-grant"}]},{"group":"Webhooks","pages":[{"title":"Receive a provider event","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/ingress/{provider}","href":"/api-reference/webhooks/receive-a-provider-event"},{"title":"Send a signed event from one source to a fleet","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/webhooks/{fleet_id}/{source}","href":"/api-reference/fleets/send-a-signed-event-from-one-source-to-a-fleet"},{"title":"Resolve a fleet approval gate","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/webhooks/{fleet_id}/approval","href":"/api-reference/webhooks/resolve-a-fleet-approval-gate"},{"title":"Receive a signed GitHub event","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/webhooks/{fleet_id}/github","href":"/api-reference/webhooks/receive-a-signed-github-event"}]},{"group":"Platform administration","pages":[{"title":"List shared model-provider credentials","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/admin/platform-keys","href":"/api-reference/admin/list-shared-model-provider-credentials"},{"title":"Set a shared model-provider credential","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json put /v1/admin/platform-keys","href":"/api-reference/admin/set-a-shared-model-provider-credential"},{"title":"Remove a shared model-provider credential","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/admin/platform-keys/{provider}","href":"/api-reference/admin/remove-a-shared-model-provider-credential"},{"title":"List models","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/admin/models","href":"/api-reference/admin/list-models"},{"title":"Add a priced model to the catalogue","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json post /v1/admin/models","href":"/api-reference/admin/add-a-priced-model-to-the-catalogue"},{"title":"Update model settings and rates","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json patch /v1/admin/models/{id}","href":"/api-reference/admin/update-model-settings-and-rates"},{"title":"Remove a model","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json delete /v1/admin/models/{id}","href":"/api-reference/admin/remove-a-model"}]}]},{"tab":"Runner operations","pages":[{"title":"Runner operations","href":"/runners"}]}]},"title":"Read a runner - agentsfleet","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}