OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.
The public REST version is part of the URL:
https://useorgx.com/api/v1
OrgX can add endpoints, optional request fields, response fields, and enum
values without changing the namespace. Clients should ignore response fields
they do not use.A breaking request or response change receives a new REST namespace and a
migration guide.Two portable documents carry a schema_version because they can move between
systems independently of the REST API:
Agent Work Receipt: agent-work-receipt/v0.1
Workload diagnosis: workload-diagnosis/0.1
No additional version header is required for REST API v1 requests.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OrgX Docs","description":"Build accountable AI work with a published REST API, SDKs, and MCP integrations.","colors":{"primary":"#14B8A6","light":"#F2F7FF","dark":"#02040A"},"logo":{"light":"https://mintcdn.com/neuromosaic/0wkAq2Z6N9GnzCkM/logo.png?fit=max\u0026auto=format\u0026n=0wkAq2Z6N9GnzCkM\u0026q=85\u0026s=da640e1558244cb3f2ea71480f7765e0","dark":"https://mintcdn.com/neuromosaic/0wkAq2Z6N9GnzCkM/logo.png?fit=max\u0026auto=format\u0026n=0wkAq2Z6N9GnzCkM\u0026q=85\u0026s=da640e1558244cb3f2ea71480f7765e0","href":"https://useorgx.com"},"favicon":"https://mintcdn.com/neuromosaic/jQgSROOHTkjtaQwb/favicon.ico?fit=max\u0026auto=format\u0026n=jQgSROOHTkjtaQwb\u0026q=85\u0026s=58f0ee6b8ef748172352db82e286b300","api":{"openapi":"openapi/v1.yaml","params":{"expanded":"closed"},"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["bash","javascript","python"],"prefill":false}},"appearance":{"default":"dark"},"background":{"decoration":"grid","color":{"light":"#F2F7FF","dark":"#02040A"}},"navbar":{"links":[{"href":"https://useorgx.com","label":"Mission Control"},{"href":"/api/mcp-protocol","label":"MCP"}],"primary":{"type":"button","label":"Connect OrgX","href":"https://useorgx.com/sign-up"}},"footer":{"socials":{"twitter":"https://twitter.com/useorgx","github":"https://github.com/useorgx","linkedin":"https://linkedin.com/company/orgx-ai"}},"search":{"prompt":"Search docs..."},"seo":{"indexing":"navigable"},"fonts":{"heading":{"family":"Geist, ui-sans-serif, system-ui, sans-serif"},"body":{"family":"Geist, ui-sans-serif, system-ui, sans-serif"}},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/useorgx"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"neuromosaic","hasAudioNarration":false,"actualSubdomain":"neuromosaic","customDomains":["docs.useorgx.com"],"gitSource":{"type":"github","owner":"hopeatina","repo":"orgx","deployBranch":"main","contentDirectory":"orgx/docs/mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae0d808edbd4c098a95242d","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"REST API v1 Reference","count":70},{"language":"default","tag":"Entity Reference","count":14},{"language":"default","tag":"Build with the API","count":10},{"language":"default","tag":"Connect Your Tools","count":10},{"language":"default","tag":"Handoffs","count":8},{"language":"default","tag":"Platform","count":6},{"language":"default","tag":"Artifacts","count":5},{"language":"default","tag":"Decisions","count":5},{"language":"default","tag":"Initiatives","count":5},{"language":"default","tag":"Operating processes","count":5}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/versioning","slug":"/api/versioning","pageMetadata":{"title":"Versioning","sidebarTitle":"Versioning","description":"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.","icon":"code-branch","href":"/api/versioning"},"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: \"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The public REST version is part of the URL:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://useorgx.com/api/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`OrgX can add endpoints, optional request fields, response fields, and enum\nvalues without changing the namespace. Clients should ignore response fields\nthey do not use.`}),`\n`,_jsx(_components.p,{children:`A breaking request or response change receives a new REST namespace and a\nmigration guide.`}),`\n`,_jsxs(_components.p,{children:[`Two portable documents carry a `,_jsx(_components.code,{children:`schema_version`}),` because they can move between\nsystems independently of the REST API:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Agent Work Receipt: `,_jsx(_components.code,{children:`agent-work-receipt/v0.1`})]}),`\n`,_jsxs(_components.li,{children:[`Workload diagnosis: `,_jsx(_components.code,{children:`workload-diagnosis/0.1`})]}),`\n`]}),`\n`,_jsx(_components.p,{children:`No additional version header is required for REST API v1 requests.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Versioning","sidebarTitle":"Versioning","description":"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.","icon":"code-branch","href":"/api/versioning"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"neuromosaic","siteName":"OrgX Docs","title":"Versioning - OrgX Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-19T05:37:33.971Z","originalFileLocation":"api/versioning.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=\"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OrgX Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_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=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Versioning - OrgX Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OrgX Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useorgx.com/docs/api/versioning\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://neuromosaic.mintlify.site/docs/_mintlify/api/og/v2?division=Build+with+the+API\u0026amp;title=Versioning\u0026amp;description=OrgX+REST+API+v1+uses+the+%2Fapi%2Fv1+namespace%3B+portable+schemas+carry+their+own+schema+version.\u0026amp;theme=3c0265eda2aaaf287ea04c96\u0026amp;signature=d7a45da0b7273403c53258871ac7f9735b1266021c3b1df5ea11d5194660d060\">\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=\"Versioning - OrgX Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://neuromosaic.mintlify.site/docs/_mintlify/api/og/v2?division=Build+with+the+API\u0026amp;title=Versioning\u0026amp;description=OrgX+REST+API+v1+uses+the+%2Fapi%2Fv1+namespace%3B+portable+schemas+carry+their+own+schema+version.\u0026amp;theme=3c0265eda2aaaf287ea04c96\u0026amp;signature=d7a45da0b7273403c53258871ac7f9735b1266021c3b1df5ea11d5194660d060\">\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=\"/docs/mintlify-assets/_mintlify/favicons/neuromosaic/L56_zgZXh-F-BOaX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OrgX Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#14B8A6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useorgx.com/docs/api/versioning\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/versioning.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useorgx.com/#organization\",\"name\":\"OrgX Docs\",\"url\":\"https://docs.useorgx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/neuromosaic/0wkAq2Z6N9GnzCkM/logo.png?fit=max\u0026auto=format\u0026n=0wkAq2Z6N9GnzCkM\u0026q=85\u0026s=da640e1558244cb3f2ea71480f7765e0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useorgx.com/docs#website\",\"name\":\"OrgX Docs\",\"url\":\"https://docs.useorgx.com/docs\",\"publisher\":{\"@id\":\"https://docs.useorgx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useorgx.com/docs/api/versioning#webpage\",\"url\":\"https://docs.useorgx.com/docs/api/versioning\",\"name\":\"Versioning\",\"description\":\"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\",\"dateModified\":\"2026-08-19T05:37:33.971Z\",\"isPartOf\":{\"@id\":\"https://docs.useorgx.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useorgx.com/docs/api/versioning#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useorgx.com/docs/api/versioning#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Build with the API\",\"item\":\"https://docs.useorgx.com/docs/api/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Versioning\",\"item\":\"https://docs.useorgx.com/docs/api/versioning\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.useorgx.com/docs/api/versioning#article\",\"headline\":\"Versioning\",\"name\":\"Versioning\",\"description\":\"OrgX REST API v1 uses the /api/v1 namespace; portable schemas carry their own schema version.\",\"url\":\"https://docs.useorgx.com/docs/api/versioning\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useorgx.com/docs/api/versioning#webpage\"},\"dateModified\":\"2026-08-19T05:37:33.971Z\",\"publisher\":{\"@id\":\"https://docs.useorgx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useorgx.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OrgX Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"OrgX Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api/versioning.md","siteName":"OrgX Docs","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/useorgx"}]},"groups":[{"group":"Getting Started","pages":[{"title":"Build accountable work with OrgX","sidebarTitle":"Start here","icon":"house","href":"/home"},{"title":"What OrgX does","sidebarTitle":"Introduction","icon":"rocket","href":"/introduction"},{"title":"Core concepts","sidebarTitle":"Concepts","icon":"lightbulb","href":"/concepts"}]},{"group":"Connect Your Tools","pages":[{"title":"Connect your AI tools","sidebarTitle":"AI Toolkit","icon":"toolbox","href":"/guides/toolkit"},{"title":"Product quickstart","sidebarTitle":"Product quickstart","icon":"bolt","href":"/quickstart"},{"title":"Your first useful result","sidebarTitle":"Onboarding contract","icon":"route","href":"/guides/onboarding"},{"title":"Pick up where you left off","icon":"flask","href":"/guides/synthetic-data-trial"},{"title":"Wizard CLI","sidebarTitle":"Wizard CLI","icon":"terminal","href":"/guides/wizard-cli-onboarding"},{"title":"Cloud agents","icon":"cloud","href":"/guides/cloud-agents"},{"title":"OpenClaw Plugin Setup","sidebarTitle":"OpenClaw Plugin","icon":"plug","href":"/guides/openclaw-plugin-setup"},{"title":"ChatGPT","sidebarTitle":"ChatGPT","icon":"comments","href":"/guides/chatgpt-integration"},{"title":"MCP Client Setup","sidebarTitle":"MCP Clients","icon":"code","href":"/guides/cursor-mcp-setup"},{"title":"Integrations","sidebarTitle":"Integrations","icon":"plug","href":"/guides/integrations"}]},{"group":"Agent Ops","pages":[{"title":"Agent Quickstart","sidebarTitle":"Quickstart","icon":"rocket","href":"/agent-ops/agent-quickstart"},{"title":"Agent Recipes","sidebarTitle":"Recipes","icon":"book","href":"/agent-ops/agent-recipes"},{"title":"Failure Playbooks","sidebarTitle":"Failure Playbooks","icon":"shield","href":"/agent-ops/failure-playbooks"},{"title":"Tool profiles","sidebarTitle":"Tool profiles","icon":"users","href":"/agent-ops/tool-profiles"}]},{"group":"Platform","pages":[{"title":"How OrgX Works","sidebarTitle":"How It Works","icon":"sitemap","href":"/platform/architecture"},{"title":"Agents","sidebarTitle":"Agents","icon":"robot","href":"/platform/agents"},{"title":"Skills","sidebarTitle":"Skills","icon":"puzzle-piece","href":"/platform/skills"},{"title":"Artifacts","sidebarTitle":"Artifacts","icon":"file-lines","href":"/platform/artifacts"},{"title":"Quality bar","sidebarTitle":"Quality bar","icon":"scale-balanced","href":"/guides/quality-bar"},{"title":"Decisions","sidebarTitle":"Decisions","icon":"check-circle","href":"/platform/decisions"}]},{"group":"Build with the API","pages":[{"title":"API quickstart","sidebarTitle":"Quickstart","icon":"bolt","href":"/api/quickstart"},{"title":"API overview","sidebarTitle":"Overview","icon":"book","href":"/api/overview"},{"title":"Authentication","sidebarTitle":"Authentication","icon":"key","href":"/api/authentication"},{"title":"API clients","sidebarTitle":"Clients","icon":"code","href":"/api/clients"},{"title":"Idempotency","sidebarTitle":"Idempotency","icon":"rotate-cw","href":"/api/idempotency"},{"title":"Errors","sidebarTitle":"Errors","icon":"triangle-exclamation","href":"/api/errors"},{"title":"Pagination","sidebarTitle":"Pagination","description":"Continue event and collection reads with the cursor returned by the API.","icon":"list","href":"/api/pagination"},{"title":"Versioning","sidebarTitle":"Versioning","icon":"code-branch","href":"/api/versioning"},{"title":"Testing safely","sidebarTitle":"Testing","description":"Use a dedicated OrgX workspace and key for development, CI, and integration review.","icon":"flask-conical","href":"/api/sandbox"},{"title":"Observability","sidebarTitle":"Observability","icon":"chart-line","href":"/api/observability"}]},{"group":"REST API v1 Reference","pages":[{"title":"REST API v1","sidebarTitle":"REST API v1","icon":"braces","href":"/api/public-api"},{"title":"Create work","openapi":"openapi/v1.yaml POST /work","href":"/api-reference/work/create"},{"title":"Complete work","openapi":"openapi/v1.yaml POST /work/{taskId}/complete","href":"/api-reference/work/complete"},{"title":"Create an initiative","openapi":"openapi/v1.yaml POST /initiatives","href":"/api-reference/initiatives/create"},{"title":"List events","openapi":"openapi/v1.yaml GET /events/stream","href":"/api-reference/events/list"},{"group":"Projections","pages":[{"title":"Prepare current context or safely rebootstrap a prior capsule","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /context-pack","href":"/api-reference/projections/prepare-current-context-or-safely-rebootstrap-a-prior-capsule"},{"title":"Get the Work Ledger","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /projections/work-ledger","href":"/api-reference/projections/get-the-work-ledger"},{"title":"Get process adoption","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /projections/adoption","href":"/api-reference/projections/get-process-adoption"},{"title":"Get process value","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /projections/value-case","href":"/api-reference/projections/get-process-value"},{"title":"Get metered usage","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /projections/meter-usage","href":"/api-reference/projections/get-metered-usage"}]},{"group":"Controllers","pages":[{"title":"Read a domain controller status projection","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /controllers/{domain}","href":"/api-reference/controllers/read-a-domain-controller-status-projection"},{"title":"Reconcile one domain controller in shadow mode","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /controllers/{domain}/reconcile","href":"/api-reference/controllers/reconcile-one-domain-controller-in-shadow-mode"}]},{"group":"Operating processes","pages":[{"title":"List operating processes","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /operating-processes","href":"/api-reference/operating-processes/list-operating-processes"},{"title":"Propose an operating process","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /operating-processes","href":"/api-reference/operating-processes/propose-an-operating-process"},{"title":"Get an operating process","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /operating-processes/{processId}","href":"/api-reference/operating-processes/get-an-operating-process"},{"title":"Confirm an operating process","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /operating-processes/{processId}/confirm","href":"/api-reference/operating-processes/confirm-an-operating-process"},{"title":"Activate an operating process","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /operating-processes/{processId}/activate","href":"/api-reference/operating-processes/activate-an-operating-process"}]},{"group":"Operating map","pages":[{"title":"Get the operating map","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /operating-map","href":"/api-reference/operating-map/get-the-operating-map"}]},{"group":"Handoffs","pages":[{"title":"List handoffs","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /handoffs","href":"/api-reference/handoffs/list-handoffs"},{"title":"Create a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs","href":"/api-reference/handoffs/create-a-handoff"},{"title":"Get a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /handoffs/{handoffId}","href":"/api-reference/handoffs/get-a-handoff"},{"title":"Claim a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs/{handoffId}/claim","href":"/api-reference/handoffs/claim-a-handoff"},{"title":"Return a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs/{handoffId}/return","href":"/api-reference/handoffs/return-a-handoff"},{"title":"Escalate a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs/{handoffId}/escalate","href":"/api-reference/handoffs/escalate-a-handoff"},{"title":"Cancel a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs/{handoffId}/cancel","href":"/api-reference/handoffs/cancel-a-handoff"},{"title":"Fulfill a handoff","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /handoffs/{handoffId}/fulfill","href":"/api-reference/handoffs/fulfill-a-handoff"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /events/stream","href":"/api-reference/events/list-events"}]},{"group":"Episodes","pages":[{"title":"List missions","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /episodes","href":"/api-reference/episodes/list-missions"}]},{"group":"Discovery runs","pages":[{"title":"List discovery runs","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /discovery-runs","href":"/api-reference/discovery-runs/list-discovery-runs"},{"title":"Discover processes","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /discovery-runs","href":"/api-reference/discovery-runs/discover-processes"},{"title":"Get a discovery run","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /discovery-runs/{runId}","href":"/api-reference/discovery-runs/get-a-discovery-run"},{"title":"Propose a discovered process","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /discovery-runs/{runId}/propose","href":"/api-reference/discovery-runs/propose-a-discovered-process"}]},{"group":"Receipt import","pages":[{"title":"Import a receipt","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /agent-work-receipts","href":"/api-reference/receipt-import/import-a-receipt"}]},{"group":"Receipt validation","pages":[{"title":"Get receipt validation metadata","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /agent-work-receipts/validate","href":"/api-reference/receipt-validation/get-receipt-validation-metadata"},{"title":"Validate a receipt","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /agent-work-receipts/validate","href":"/api-reference/receipt-validation/validate-a-receipt"}]},{"group":"Workload diagnosis","pages":[{"title":"Get workload diagnosis metadata","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /doctor/workload","href":"/api-reference/workload-diagnosis/get-workload-diagnosis-metadata"},{"title":"Diagnose a workload","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /doctor/workload","href":"/api-reference/workload-diagnosis/diagnose-a-workload"}]},{"group":"Content Studio","pages":[{"title":"Estimate Content Studio work","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /studio/estimate","href":"/api-reference/content-studio/estimate-content-studio-work"},{"title":"List Content Studio examples","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /studio/showcase","href":"/api-reference/content-studio/list-content-studio-examples"},{"title":"Create a Content Studio checkout","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /studio/checkout","href":"/api-reference/content-studio/create-a-content-studio-checkout"},{"title":"Receive Stripe events","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /studio/callback","href":"/api-reference/content-studio/receive-stripe-events"}]},{"group":"Work","pages":[{"title":"List work","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /work","href":"/api-reference/work/list-work"},{"title":"Create work","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /work","href":"/api-reference/work/create-work"},{"title":"Complete work with evidence","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /work/{taskId}/complete","href":"/api-reference/work/complete-work-with-evidence"},{"title":"Get a work item with its concurrency tokens","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /work/{taskId}","href":"/api-reference/work/get-a-work-item-with-its-concurrency-tokens"}]},{"group":"Initiatives","pages":[{"title":"Create an initiative","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /initiatives","href":"/api-reference/initiatives/create-an-initiative"},{"title":"Read an initiative, optionally with its full tree","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /initiatives/{initiativeId}","href":"/api-reference/initiatives/read-an-initiative-optionally-with-its-full-tree"},{"title":"Generate a reviewable initiative plan proposal","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /initiatives/proposals","href":"/api-reference/initiatives/generate-a-reviewable-initiative-plan-proposal"},{"title":"Read a stored initiative plan proposal","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /initiatives/proposals/{proposalId}","href":"/api-reference/initiatives/read-a-stored-initiative-plan-proposal"},{"title":"Create a staged legacy scaffold batch","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /workflows/legacy-scaffold-batch","href":"/api-reference/initiatives/create-a-staged-legacy-scaffold-batch"}]},{"group":"Artifacts","pages":[{"title":"List artifact types","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /artifact-types","href":"/api-reference/artifacts/list-artifact-types"},{"title":"List artifacts","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /artifacts","href":"/api-reference/artifacts/list-artifacts"},{"title":"Register an artifact","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /artifacts","href":"/api-reference/artifacts/register-an-artifact"},{"title":"List artifacts for one entity","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /artifacts/by-entity","href":"/api-reference/artifacts/list-artifacts-for-one-entity"},{"title":"Get an artifact","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /artifacts/{artifactId}","href":"/api-reference/artifacts/get-an-artifact"}]},{"group":"Decisions","pages":[{"title":"List decisions","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /decisions","href":"/api-reference/decisions/list-decisions"},{"title":"Raise a decision","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /decisions","href":"/api-reference/decisions/raise-a-decision"},{"title":"Read one decision","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /decisions/{id}","href":"/api-reference/decisions/read-one-decision"},{"title":"Ask a human to look at a decision","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /decisions/{id}/attention","href":"/api-reference/decisions/ask-a-human-to-look-at-a-decision"},{"title":"Rule on a decision","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /decisions/{id}/resolution","href":"/api-reference/decisions/rule-on-a-decision"}]},{"group":"Runs","pages":[{"title":"Control an agent run","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /runs/{runId}/actions/{action}","href":"/api-reference/runs/control-an-agent-run"}]},{"group":"Lifecycle","pages":[{"title":"Pause, resume, retry, or cancel a work node","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /lifecycle","href":"/api-reference/lifecycle/pause-resume-retry-or-cancel-a-work-node"}]},{"group":"Deduplication","pages":[{"title":"Claim a duplicate-trigger fingerprint","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /live/dedup/claim","href":"/api-reference/deduplication/claim-a-duplicate-trigger-fingerprint"}]},{"group":"Credential","pages":[{"title":"Describe the calling credential","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /me","href":"/api-reference/credential/describe-the-calling-credential"}]},{"group":"API discovery","pages":[{"title":"List the API error codes","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /errors","href":"/api-reference/api-discovery/list-the-api-error-codes"},{"title":"Get request schemas for v1 operations","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /meta/schemas","href":"/api-reference/api-discovery/get-request-schemas-for-v1-operations"},{"title":"Get the closed vocabularies","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /meta/enums","href":"/api-reference/api-discovery/get-the-closed-vocabularies"}]},{"group":"Launches","pages":[{"title":"Preview or execute an initiative launch","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /launches","href":"/api-reference/launches/preview-or-execute-an-initiative-launch"},{"title":"Read a launch with its jobs, runs, receipts, and spend","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml get /launches/{launchId}","href":"/api-reference/launches/read-a-launch-with-its-jobs-runs-receipts-and-spend"},{"title":"Stop a launch and release its spend reservation","deprecated":null,"version":null,"openapi":"/openapi/v1.yaml post /launches/{launchId}/cancel","href":"/api-reference/launches/stop-a-launch-and-release-its-spend-reservation"}]}]},{"group":"Entity Reference","pages":[{"title":"Entity map","sidebarTitle":"Entity map","icon":"map","href":"/api/entities/overview"},{"title":"Workspace","sidebarTitle":"Workspace","icon":"building","href":"/api/entities/workspace"},{"title":"Work item","sidebarTitle":"Work item","icon":"list-check","href":"/api/entities/work-item"},{"title":"Initiative","sidebarTitle":"Initiative","icon":"flag","href":"/api/entities/initiative"},{"title":"Decision","sidebarTitle":"Decision","icon":"scale-balanced","href":"/api/entities/decision"},{"title":"Artifacts","sidebarTitle":"Artifacts","icon":"file-check","href":"/api/entities/artifact"},{"title":"Agent run","sidebarTitle":"Agent run","icon":"play","href":"/api/entities/run"},{"title":"Operating process","sidebarTitle":"Operating process","icon":"diagram-project","href":"/api/entities/operating-process"},{"title":"Handoff","sidebarTitle":"Handoff","icon":"arrows-turn-right","href":"/api/entities/handoff"},{"title":"Discovery run","sidebarTitle":"Discovery run","icon":"magnifying-glass-chart","href":"/api/entities/discovery-run"},{"title":"Ledger event","sidebarTitle":"Ledger event","icon":"wave-square","href":"/api/entities/ledger-event"},{"title":"Receipt","sidebarTitle":"Receipt","icon":"receipt","href":"/api/entities/receipt"},{"title":"Episode","sidebarTitle":"Episode","icon":"clapperboard","href":"/api/entities/episode"},{"title":"Projections","sidebarTitle":"Projections","icon":"chart-line","href":"/api/entities/projections"}]},{"group":"Content Studio API","pages":[{"title":"Content Studio API","sidebarTitle":"Overview","icon":"palette","href":"/api/content-studio"},{"title":"Stripe callback","sidebarTitle":"Stripe callback","icon":"webhook","href":"/api/webhooks"}]},{"group":"MCP and Plugins","pages":[{"title":"OrgX MCP","sidebarTitle":"Overview","icon":"server","href":"/api/mcp-protocol"},{"title":"MCP Tools Reference","sidebarTitle":"MCP Tools","icon":"wrench","href":"/api/mcp-tools"},{"title":"MCP and REST parity","sidebarTitle":"MCP ↔ REST parity","icon":"code-compare","href":"/api/mcp-rest-parity"},{"title":"OpenClaw Plugin MCP Tools","sidebarTitle":"OpenClaw Plugin Tools","icon":"plug","href":"/api/openclaw-plugin-mcp-tools"}]},{"group":"Resources","pages":[{"title":"Security \u0026 Privacy","sidebarTitle":"Security","icon":"shield","href":"/resources/security"},{"title":"Availability","sidebarTitle":"Availability","icon":"circle-check","href":"/resources/roadmap"},{"title":"FAQ","sidebarTitle":"FAQ","icon":"circle-question","href":"/resources/faq"},{"title":"LLM-ready documentation","sidebarTitle":"LLM-ready docs","icon":"sparkles","href":"/resources/llm-ingestion"}]}]},"basePath":"","title":"Versioning - OrgX Docs","buildId":"dpl_Eok1jboeiLTUE4ccnKdogAktkDhH","deploymentId":"dpl_Eok1jboeiLTUE4ccnKdogAktkDhH","dynamics":[],"chunks":[]}