Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Query parameters
integer
Max results (1-100, default 20)
integer
Results offset (default 0)
string
Comma-separated state filter (e.g. running,paused)
Read the source OpenAPI document for declared schemas and alternatives.
This page also includes documented corrections from the spec overlays.
Example IDs and values are illustrative; replace them with records from your workspace.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"StateSet","colors":{"primary":"#1854D8","light":"#9ABBFF","dark":"#1854D8"},"logo":{"light":"https://mintcdn.com/stateset/4wTHkssFeA2M0XSV/logo/stateset28.svg?fit=max\u0026auto=format\u0026n=4wTHkssFeA2M0XSV\u0026q=85\u0026s=24804c100796a1bf65ec331da17e6d35","dark":"https://mintcdn.com/stateset/JA8nckTOtvEhuHo_/logo/stateset-dark.svg?fit=max\u0026auto=format\u0026n=JA8nckTOtvEhuHo_\u0026q=85\u0026s=65eb9e8c70dcd90948e7767e33664716","href":"https://docs.stateset.com"},"favicon":"https://mintcdn.com/stateset/-A-d_TFUEdlnuegX/logo/favicon.png?fit=max\u0026auto=format\u0026n=-A-d_TFUEdlnuegX\u0026q=85\u0026s=0104c780f4ff026e880a05450e1156b0","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.stateset.com"}},"background":{"color":{"light":"#FFFFFF","dark":"#101827"}},"navbar":{"links":[{"href":"https://stateset.com/contact-us","label":"Talk to us"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.stateset.com"}},"footer":{"socials":{"x":"https://x.com/stateset","github":"https://github.com/stateset","linkedin":"https://www.linkedin.com/company/stateset"},"links":[{"header":"Explore","items":[{"label":"Sandbox","href":"https://sandbox.stateset.com"},{"label":"ResponseCX","href":"https://response.cx"},{"label":"Console","href":"https://console.stateset.com"}]},{"header":"Resources","items":[{"label":"Customers","href":"https://stateset.com/customers"},{"label":"Blog","href":"https://stateset.com/blog"},{"label":"Pricing","href":"https://stateset.com/pricing"},{"label":"Contact support","href":"https://stateset.com/support"},{"label":"Glossary","href":"https://www.stateset.com/glossary/icommerce/glossary"},{"label":"Status","href":"https://stateset.com/status"}]},{"header":"Company","items":[{"label":"Careers","href":"https://stateset.com/careers"},{"label":"FAQs","href":"https://stateset.com/faqs"},{"label":"Community","href":"https://discord.gg/VfcaqgZywq"},{"label":"Newsletter","href":"https://stateofmind.beehiiv.com/"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://stateset.com/privacy"},{"label":"Terms of Service","href":"https://stateset.com/terms"},{"label":"Trust Center","href":"https://trust.stateset.com"}]}]},"search":{"prompt":"Search guides, APIs, and MCP tools…"},"seo":{"metatags":{"og:type":"website","og:site_name":"StateSet API Docs","og:title":"StateSet API Docs","og:description":"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.","twitter:card":"summary_large_image","twitter:site":"@stateset"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"errors":{"404":{"redirect":false,"title":"This page does not exist","description":"It may have been retired — 376 old URLs redirect automatically, but you found one that doesn't. Try the [API router](/api-reference/introduction) to find the right surface, [host status](/api-reference/hosts) if a service seems missing, or [Getting Help](/support)."}},"contextual":{"options":["copy","chatgpt","claude","cursor"],"display":"header"},"thumbnails":{"appearance":"dark"},"interaction":{"drilldown":false},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/stateset"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stateset","hasAudioNarration":false,"actualSubdomain":"stateset","customDomains":["docs.stateset.com"],"gitSource":{"type":"github","owner":"stateset","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af760fef96917bc1916b111","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1570},{"language":"default","tag":"iCommerce","count":482},{"language":"default","tag":"Platform docs","count":317},{"language":"default","tag":"NSR","count":264},{"language":"default","tag":"Learn \u0026 build","count":238},{"language":"default","tag":"EDI","count":204},{"language":"default","tag":"Temporal Engine","count":182},{"language":"default","tag":"Financials","count":97},{"language":"default","tag":"Computer Use","count":92},{"language":"default","tag":"Orders \u0026 Customers","count":88}],"searchSettings":{"maxResults":8}},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--ss-page: #ffffff;--ss-ink: #15243b;--ss-muted: #4e6078;--ss-line: #dce4ef;--ss-surface: #f5f8fd;--ss-accent: #1854d8}.dark{--ss-page: #101827;--ss-ink: #edf3ff;--ss-muted: #b0bfd4;--ss-line: #304057;--ss-surface: #182337;--ss-accent: #9abbff}html,body{background-color:var(--ss-page)}#navbar{border-bottom-color:var(--ss-line)}#search-bar-entry{border-color:var(--ss-line);border-radius:12px}#sidebar a{transition:background-color 140ms ease, color 140ms ease}#content-area h1{letter-spacing:-0.035em;text-wrap:balance}#content-area h2{letter-spacing:-0.025em}#content-area h3{letter-spacing:-0.015em}#content-area :is(a,button,[role=\"link\"]):focus-visible,#sidebar :is(a,button):focus-visible,#navbar :is(a,button):focus-visible,#footer :is(a,button):focus-visible{outline:3px solid var(--ss-accent);outline-offset:4px}#content-area .card{border-color:var(--ss-line);border-radius:16px;box-shadow:0 2px 5px rgb(15 35 65 / 3%);transition:border-color 160ms ease, box-shadow 160ms ease}#content-area .card:hover{border-color:var(--ss-accent);box-shadow:0 6px 20px rgb(15 35 65 / 7%)}#content-area th{background:var(--ss-surface)}#content-area :is(th,td){border-bottom-color:var(--ss-line)}.ss-home-actions{display:flex;flex-wrap:wrap;align-items:center;gap:0.75rem 1.5rem;margin:0 0 1.75rem}.ss-eyebrow{display:block;font-size:0.75rem;font-weight:700;letter-spacing:0.08em;color:var(--ss-accent)}#content-area .ss-primary-link,#content-area .ss-secondary-link{display:inline-flex;align-items:center;gap:0.75rem;font-size:0.875rem;font-weight:600;text-decoration:none;border-bottom:0}#content-area .ss-primary-link{padding:0.7rem 1rem;border-radius:10px;background:#1854d8;color:#fff}#content-area .ss-primary-link:hover{background:#1244b7}#content-area .ss-secondary-link{color:var(--ss-accent)}#content-area .ss-secondary-link:hover{text-decoration:underline;text-underline-offset:4px}.ss-reference-strip{display:flex;flex-wrap:wrap;gap:0.5rem 1rem;margin:1.25rem 0 2rem;padding:1rem 1.25rem;background:var(--ss-surface);border:1px solid var(--ss-line);border-radius:12px;font-size:0.875rem}.ss-reference-strip>span{flex-basis:100%;font-weight:600;color:var(--ss-muted)}.ss-operation-map{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));margin:1.5rem 0 2.5rem;border:1px solid var(--ss-line);border-radius:16px;background:var(--ss-surface)}.ss-operation-map>div{padding:1.25rem}.ss-operation-map>div+div{border-left:1px solid var(--ss-line)}.ss-operation-map strong{display:block;margin-top:0.65rem;font-size:0.95rem;color:var(--ss-ink)}#content-area .ss-operation-map p{margin:0.5rem 0 0;font-size:0.875rem;line-height:1.6;color:var(--ss-muted)}.ss-guide-summary{display:grid;grid-template-columns:1fr 1.3fr 1.3fr;gap:1.25rem;padding:1.25rem;margin:0 0 1.75rem;border:1px solid var(--ss-line);border-radius:14px;background:var(--ss-surface)}.ss-guide-summary strong{display:block;margin-top:0.5rem;color:var(--ss-ink);font-size:0.9rem}#content-area .ss-guide-summary p{margin:0.5rem 0 0;font-size:0.875rem;line-height:1.6;color:var(--ss-muted)}.ss-checkpoint{border-left:3px solid var(--ss-accent);border-radius:0 10px 10px 0;background:var(--ss-surface);padding:0.85rem 1.1rem;margin:1.5rem 0}#content-area .ss-checkpoint p{margin:0}#content-area th{padding:0.7rem 0.75rem}#content-area td{padding:0.8rem 0.75rem;vertical-align:top;line-height:1.6}#content-area :is(h2,h3){scroll-margin-top:8rem}#content-area :is(a,button,[role=\"tab\"]),#navbar button{-webkit-tap-highlight-color:transparent}#content-area .ss-primary-link,#content-area .ss-secondary-link{min-height:44px}#content-area [data-component-part=\"card-icon\"]{padding:0.5rem;box-sizing:content-box;background:var(--ss-surface);border-radius:10px}@media (max-width: 640px){.ss-home-actions{gap:0.5rem 1rem}.ss-operation-map,.ss-guide-summary{grid-template-columns:1fr}.ss-operation-map>div+div{border-left:0;border-top:1px solid var(--ss-line)}.ss-guide-summary{gap:1rem}.ss-guide-summary>div{display:grid;grid-template-columns:6.5rem 1fr;gap:0.5rem;align-items:baseline}#content-area .ss-guide-summary :is(p,strong){margin-top:0}}@media (prefers-reduced-motion: reduce){#sidebar a,#content-area .card{transition:none}}@media (forced-colors: active){.ss-checkpoint,.ss-guide-summary,.ss-operation-map,.ss-reference-strip{border:1px solid CanvasText}#content-area .ss-primary-link{border:1px solid ButtonText}}@media (max-width: 400px){#footer .nav-logo{max-width:140px}#footer div:has(>a .nav-logo){flex-wrap:wrap;gap:1rem}}#footer :is(a,span){color:var(--ss-muted)}#footer a:hover{color:var(--ss-accent)}.ss-test-sequence{display:grid;gap:1rem;margin:1.5rem 0}.ss-test-sequence .ss-test-case{border:1px solid var(--ss-line);border-radius:14px;padding:1.25rem}#content-area .ss-test-sequence h3{margin:0.5rem 0 0.75rem;font-size:1.1rem}#content-area .ss-test-sequence .ss-test-question{margin:0;padding:0.75rem 1rem;background:var(--ss-surface);border-left:3px solid var(--ss-accent);font-style:normal;color:var(--ss-ink)}#content-area .ss-test-sequence p{margin:0.85rem 0 0;font-size:0.9rem;line-height:1.7}"}]}
{"page":{"pagePath":"api-reference/sandbox/sandboxes-list","slug":"/api-reference/sandbox/sandboxes-list","pageMetadata":{"title":"List sandboxes for the authenticated organization","api":"GET https://api.sandbox.stateset.app/api/v1/sandboxes","description":"Paginated list of sandboxes","href":"/api-reference/sandbox/sandboxes-list"},"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: \"Paginated list of sandboxes\"\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={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Confirm your deployment before running this request.`}),` This page describes an API contract;\na published reference does not establish hosted availability. Check the dated\n`,_jsx(_components.a,{href:`/api-reference/hosts`,children:`host report`}),` and obtain your deployment URL and credentials.\nReplace the example host if your provisioned service uses a different URL.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsx(ParamField,{query:`limit`,type:`integer`,id:`param-limit`,children:_jsx(_components.p,{children:`Max results (1-100, default 20)`})}),`\n`,_jsx(ParamField,{query:`offset`,type:`integer`,id:`param-offset`,children:_jsx(_components.p,{children:`Results offset (default 0)`})}),`\n`,_jsx(ParamField,{query:`state`,type:`string`,id:`param-state`,children:_jsx(_components.p,{children:`Comma-separated state filter (e.g. running,paused)`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`object`})}),`\n`,_jsx(ResponseField,{name:`sandboxes`,type:`object[]`,required:true,id:`param-sandboxes`,children:_jsxs(Expandable,{title:`sandboxes`,children:[_jsx(ResponseField,{name:`sandbox_id`,type:`string (uuid)`,required:true,id:`param-sandbox-id`}),_jsx(ResponseField,{name:`org_id`,type:`string`,required:true,id:`param-org-id`}),_jsx(ResponseField,{name:`session_id`,type:`string`,required:true,id:`param-session-id`}),_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[`Allowed values: `,_jsx(_components.code,{children:`'creating'`}),`, `,_jsx(_components.code,{children:`'running'`}),`, `,_jsx(_components.code,{children:`'paused'`}),`, `,_jsx(_components.code,{children:`'terminating'`}),`, `,_jsx(_components.code,{children:`'terminated'`}),`, `,_jsx(_components.code,{children:`'error'`}),`.`]})}),_jsx(ResponseField,{name:`allocated_vcpu`,type:`number`,id:`param-allocated-vcpu`,children:_jsx(_components.p,{children:`Allocated vCPU cores.`})}),_jsx(ResponseField,{name:`allocated_memory_gib`,type:`number`,id:`param-allocated-memory-gib`,children:_jsx(_components.p,{children:`Allocated memory in GiB.`})}),_jsx(ResponseField,{name:`created_at`,type:`string (date-time)`,required:true,id:`param-created-at`}),_jsx(ResponseField,{name:`expires_at`,type:`string (date-time)`,required:true,id:`param-expires-at`}),_jsx(ResponseField,{name:`max_expires_at`,type:`string (date-time)`,required:true,id:`param-max-expires-at`}),_jsx(ResponseField,{name:`max_lifetime_seconds`,type:`integer`,required:true,id:`param-max-lifetime-seconds`}),_jsx(ResponseField,{name:`remaining_extend_seconds`,type:`integer`,required:true,id:`param-remaining-extend-seconds`}),_jsx(ResponseField,{name:`lifetime_used_seconds`,type:`integer`,required:true,id:`param-lifetime-used-seconds`}),_jsx(ResponseField,{name:`lifetime_used_percent`,type:`number`,required:true,id:`param-lifetime-used-percent`})]})}),`\n`,_jsx(ResponseField,{name:`pagination`,type:`object`,required:true,id:`param-pagination`,children:_jsxs(Expandable,{title:`pagination`,children:[_jsx(ResponseField,{name:`limit`,type:`integer`,required:true,id:`param-limit-1`}),_jsx(ResponseField,{name:`offset`,type:`integer`,required:true,id:`param-offset-1`}),_jsx(ResponseField,{name:`total`,type:`integer`,required:true,id:`param-total`}),_jsx(ResponseField,{name:`has_more`,type:`boolean`,required:true,id:`param-has-more`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`status-codes`,children:`Status codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:`Paginated list of sandboxes`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`using-this-contract`,children:`Using this contract`}),`\n`,_jsxs(_components.p,{children:[`Read the `,_jsx(_components.a,{href:`/spec/sandbox.json`,children:`source OpenAPI document`}),` for declared schemas and alternatives.\nThis page also includes documented corrections from the `,_jsx(_components.a,{href:`https://github.com/stateset/docs/tree/main/spec/overlays`,children:`spec overlays`}),`.\nExample IDs and values are illustrative; replace them with records from your workspace.`]})]})}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":{"config":{},"pageMetadata":{"title":"List sandboxes for the authenticated organization","api":"GET https://api.sandbox.stateset.app/api/v1/sandboxes","description":"Paginated list of sandboxes","href":"/api-reference/sandbox/sandboxes-list"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Confirm your deployment before running this request.`}),` This page describes an API contract;\na published reference does not establish hosted availability. Check the dated\n`,_jsx(_components.a,{href:`/api-reference/hosts`,children:`host report`}),` and obtain your deployment URL and credentials.\nReplace the example host if your provisioned service uses a different URL.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`query-parameters`,children:`Query parameters`}),`\n`,_jsx(ParamField,{query:`limit`,type:`integer`,id:`param-limit`,children:_jsx(_components.p,{children:`Max results (1-100, default 20)`})}),`\n`,_jsx(ParamField,{query:`offset`,type:`integer`,id:`param-offset`,children:_jsx(_components.p,{children:`Results offset (default 0)`})}),`\n`,_jsx(ParamField,{query:`state`,type:`string`,id:`param-state`,children:_jsx(_components.p,{children:`Comma-separated state filter (e.g. running,paused)`})}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`object`})}),`\n`,_jsx(ResponseField,{name:`sandboxes`,type:`object[]`,required:true,id:`param-sandboxes`,children:_jsxs(Expandable,{title:`sandboxes`,children:[_jsx(ResponseField,{name:`sandbox_id`,type:`string (uuid)`,required:true,id:`param-sandbox-id`}),_jsx(ResponseField,{name:`org_id`,type:`string`,required:true,id:`param-org-id`}),_jsx(ResponseField,{name:`session_id`,type:`string`,required:true,id:`param-session-id`}),_jsx(ResponseField,{name:`status`,type:`string`,required:true,id:`param-status`,children:_jsxs(_components.p,{children:[`Allowed values: `,_jsx(_components.code,{children:`'creating'`}),`, `,_jsx(_components.code,{children:`'running'`}),`, `,_jsx(_components.code,{children:`'paused'`}),`, `,_jsx(_components.code,{children:`'terminating'`}),`, `,_jsx(_components.code,{children:`'terminated'`}),`, `,_jsx(_components.code,{children:`'error'`}),`.`]})}),_jsx(ResponseField,{name:`allocated_vcpu`,type:`number`,id:`param-allocated-vcpu`,children:_jsx(_components.p,{children:`Allocated vCPU cores.`})}),_jsx(ResponseField,{name:`allocated_memory_gib`,type:`number`,id:`param-allocated-memory-gib`,children:_jsx(_components.p,{children:`Allocated memory in GiB.`})}),_jsx(ResponseField,{name:`created_at`,type:`string (date-time)`,required:true,id:`param-created-at`}),_jsx(ResponseField,{name:`expires_at`,type:`string (date-time)`,required:true,id:`param-expires-at`}),_jsx(ResponseField,{name:`max_expires_at`,type:`string (date-time)`,required:true,id:`param-max-expires-at`}),_jsx(ResponseField,{name:`max_lifetime_seconds`,type:`integer`,required:true,id:`param-max-lifetime-seconds`}),_jsx(ResponseField,{name:`remaining_extend_seconds`,type:`integer`,required:true,id:`param-remaining-extend-seconds`}),_jsx(ResponseField,{name:`lifetime_used_seconds`,type:`integer`,required:true,id:`param-lifetime-used-seconds`}),_jsx(ResponseField,{name:`lifetime_used_percent`,type:`number`,required:true,id:`param-lifetime-used-percent`})]})}),`\n`,_jsx(ResponseField,{name:`pagination`,type:`object`,required:true,id:`param-pagination`,children:_jsxs(Expandable,{title:`pagination`,children:[_jsx(ResponseField,{name:`limit`,type:`integer`,required:true,id:`param-limit-1`}),_jsx(ResponseField,{name:`offset`,type:`integer`,required:true,id:`param-offset-1`}),_jsx(ResponseField,{name:`total`,type:`integer`,required:true,id:`param-total`}),_jsx(ResponseField,{name:`has_more`,type:`boolean`,required:true,id:`param-has-more`})]})}),`\n`,_jsx(Heading,{level:`3`,id:`status-codes`,children:`Status codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:`Paginated list of sandboxes`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`using-this-contract`,children:`Using this contract`}),`\n`,_jsxs(_components.p,{children:[`Read the `,_jsx(_components.a,{href:`/spec/sandbox.json`,children:`source OpenAPI document`}),` for declared schemas and alternatives.\nThis page also includes documented corrections from the `,_jsx(_components.a,{href:`https://github.com/stateset/docs/tree/main/spec/overlays`,children:`spec overlays`}),`.\nExample IDs and values are illustrative; replace them with records from your workspace.`]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --silent`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --show-error`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --fail-with-body`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.sandbox.stateset.app/api/v1/sandboxes'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'Authorization: ApiKey YOUR_API_KEY'`})]}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`200`,numberOfLines:`25`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`25`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sandboxes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sandbox_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"org_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"session_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"creating\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"allocated_vcpu\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1.5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"allocated_memory_gib\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1.5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31T14:22:05Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31T14:22:05Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"max_expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31T14:22:05Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"max_lifetime_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`250`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"remaining_extend_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`250`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lifetime_used_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`250`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"lifetime_used_percent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`7.5`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pagination\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"offset\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`102`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_more\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}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":{"config":{},"pageMetadata":{"title":"List sandboxes for the authenticated organization","api":"GET https://api.sandbox.stateset.app/api/v1/sandboxes","description":"Paginated list of sandboxes","href":"/api-reference/sandbox/sandboxes-list"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Query parameters","slug":"query-parameters","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]},{"title":"Status codes","slug":"status-codes","depth":3,"children":[]},{"title":"Using this contract","slug":"using-this-contract","depth":3,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --silent\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --show-error\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --fail-with-body\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> GET\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://api.sandbox.stateset.app/api/v1/sandboxes'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'Authorization: ApiKey YOUR_API_KEY'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"200","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"25\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sandboxes\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"sandbox_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"org_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"session_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"creating\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"allocated_vcpu\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1.5\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"allocated_memory_gib\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1.5\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-31T14:22:05Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"expires_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-31T14:22:05Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"max_expires_at\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-31T14:22:05Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"max_lifetime_seconds\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">250\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"remaining_extend_seconds\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">250\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"lifetime_used_seconds\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">250\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"lifetime_used_percent\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">7.5\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"pagination\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"limit\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">20\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"offset\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"total\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">102\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"has_more\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">true\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"List sandboxes for the authenticated organization","path":"/api/v1/sandboxes","servers":[{"url":"https://api.sandbox.stateset.app"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"limit":{"schema":[{"type":"integer","description":"Max results (1-100, default 20)"}]},"offset":{"schema":[{"type":"integer","description":"Results offset (default 0)"}]},"state":{"schema":[{"type":"string","description":"Comma-separated state filter (e.g. running,paused)"}]}},"header":{},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"sandboxes":[{"type":"array","items":[{"type":"object","properties":{"sandbox_id":[{"type":"object","properties":{},"required":true}],"org_id":[{"type":"string","required":true}],"session_id":[{"type":"string","required":true}],"status":[{"type":"string","description":"Allowed values: `'creating'` , `'running'` , `'paused'` , `'terminating'` , `'terminated'` , `'error'` .","required":true}],"allocated_vcpu":[{"type":"number","description":"Allocated vCPU cores."}],"allocated_memory_gib":[{"type":"number","description":"Allocated memory in GiB."}],"created_at":[{"type":"object","properties":{},"required":true}],"expires_at":[{"type":"object","properties":{},"required":true}],"max_expires_at":[{"type":"object","properties":{},"required":true}],"max_lifetime_seconds":[{"type":"integer","required":true}],"remaining_extend_seconds":[{"type":"integer","required":true}],"lifetime_used_seconds":[{"type":"integer","required":true}],"lifetime_used_percent":[{"type":"number","required":true}]}}],"required":true}],"pagination":[{"type":"object","properties":{"limit":[{"type":"integer","required":true}],"offset":[{"type":"integer","required":true}],"total":[{"type":"integer","required":true}],"has_more":[{"type":"boolean","required":true}]},"required":true}]}}],"examples":{"example":{"value":{"sandboxes":[{"sandbox_id":{},"org_id":"\u003cstring>","session_id":"\u003cstring>","status":"\u003cstring>","allocated_vcpu":123,"allocated_memory_gib":123,"created_at":{},"expires_at":{},"max_expires_at":{},"max_lifetime_seconds":123,"remaining_extend_seconds":123,"lifetime_used_seconds":123,"lifetime_used_percent":123}],"pagination":{"limit":123,"offset":123,"total":123,"has_more":true}}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"stateset","siteName":"StateSet","title":"StateSet API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T19:12:28.751Z","gitLastModified":"2026-10-20T19:16:57.000Z","originalFileLocation":"api-reference/sandbox/sandboxes-list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Paginated list of sandboxes\">\u003cmeta data-mint-head name=\"application-name\" content=\"StateSet\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_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/stateset/e2dvUYlL-CpWYzc1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"StateSet API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"StateSet API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stateset.mintlify.site/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+sandboxes+for+the+authenticated+organization\u0026amp;description=Paginated+list+of+sandboxes\u0026amp;theme=8b886a933b8fdd889c9fff09\u0026amp;signature=a076729674e6702a21556e3707224fd9caf324da18351300fa55e7db75b48b22\">\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=\"StateSet API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Documentation for the StateSet iCommerce Engine — the execution layer for AI commerce. APIs, SDKs, MCP servers and skills for every service.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stateset.mintlify.site/_mintlify/api/og/v2?division=Sandboxes\u0026amp;title=List+sandboxes+for+the+authenticated+organization\u0026amp;description=Paginated+list+of+sandboxes\u0026amp;theme=8b886a933b8fdd889c9fff09\u0026amp;signature=a076729674e6702a21556e3707224fd9caf324da18351300fa55e7db75b48b22\">\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/stateset/e2dvUYlL-CpWYzc1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"StateSet\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1854D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandbox/sandboxes-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stateset.com/#organization\",\"name\":\"StateSet\",\"url\":\"https://docs.stateset.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stateset/4wTHkssFeA2M0XSV/logo/stateset28.svg?fit=max\u0026auto=format\u0026n=4wTHkssFeA2M0XSV\u0026q=85\u0026s=24804c100796a1bf65ec331da17e6d35\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stateset.com#website\",\"name\":\"StateSet\",\"url\":\"https://docs.stateset.com\",\"publisher\":{\"@id\":\"https://docs.stateset.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list#webpage\",\"url\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list\",\"name\":\"List sandboxes for the authenticated organization\",\"description\":\"Paginated list of sandboxes\",\"dateModified\":\"2026-10-20T19:16:57.000Z\",\"isPartOf\":{\"@id\":\"https://docs.stateset.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sandboxes\",\"item\":\"https://docs.stateset.com/api-reference/sandbox/register-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List sandboxes for the authenticated organization\",\"item\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list#apireference\",\"headline\":\"List sandboxes for the authenticated organization\",\"name\":\"List sandboxes for the authenticated organization\",\"description\":\"Paginated list of sandboxes\",\"url\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stateset.com/api-reference/sandbox/sandboxes-list#webpage\"},\"dateModified\":\"2026-10-20T19:16:57.000Z\",\"publisher\":{\"@id\":\"https://docs.stateset.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stateset.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"StateSet\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"StateSet\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/sandbox/sandboxes-list.md","siteName":"StateSet","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/stateset"}]},"dropdowns":[{"dropdown":"Platform docs","icon":"book","description":"Products, guides and concepts","tabs":[{"tab":"Learn \u0026 build","icon":"book","groups":[{"group":"Get started","icon":"rocket","pages":[{"sidebarTitle":"Overview","title":"Build your first working operation","href":"/introduction"},{"sidebarTitle":"Signup to first value","title":"From Signup to First Value","icon":"rocket","href":"/guides/platform-onboarding"},{"sidebarTitle":"First local operation","title":"Your First Operation","icon":"play","href":"/guides/first-operation"},{"sidebarTitle":"Agent quickstart","title":"Getting Started for AI Agents","icon":"robot","href":"/getting-started-for-ai-agents"},{"title":"Why StateSet","icon":"scale-balanced","href":"/why-stateset"}]},{"group":"Build your first integration","icon":"blocks","pages":[{"sidebarTitle":"First support agent","title":"Your First Support Agent","icon":"bot","href":"/guides/first-support-agent"},{"sidebarTitle":"Workflow trial","title":"Your First Workflow Trial","icon":"workflow","href":"/guides/first-workflow-trial"},{"sidebarTitle":"Connect through MCP","title":"Manage Agents \u0026 Workflows with MCP","icon":"plug","href":"/guides/manage-platform-with-mcp"},{"title":"ResponseCX Quickstart","href":"/quickstart"},{"sidebarTitle":"Connect your systems","title":"Connect Your Operation","icon":"plug","href":"/guides/connect-your-operation"},{"sidebarTitle":"Rust engines \u0026 MCP","title":"Build Operations with Rust Engines \u0026 MCP","icon":"cpu","href":"/guides/rust-engines-and-mcp"},{"title":"Developer Guide","href":"/development"}]},{"group":"Operate and improve","icon":"activity","pages":[{"sidebarTitle":"Agent evaluations","title":"Your First Agent Evaluation","icon":"check-check","href":"/guides/first-agent-evaluation"},{"sidebarTitle":"Configuration changes","title":"Your First Workflow Configuration Change","icon":"git-pull-request","href":"/guides/first-workflow-config-change"},{"sidebarTitle":"Durable agents","title":"Operate Your First Durable Agent","icon":"bot","href":"/guides/first-durable-agent"},{"sidebarTitle":"Your first week","title":"Your First Week with StateSet","icon":"chart-line","href":"/guides/first-week-with-stateset"},{"title":"Launch a brand that runs itself","href":"/guides/launch-a-brand-autonomously"}]},{"group":"Resources and support","icon":"life-buoy","pages":[{"title":"Brand Onboarding","icon":"rocket","href":"/stateset-onboarding"},{"title":"ResponseCX","href":"/guides/response-quickstart"},{"sidebarTitle":"Troubleshooting","title":"Troubleshoot Your First Operation","icon":"life-ring","href":"/guides/onboarding-troubleshooting"},{"title":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"title":"Getting Help","icon":"life-ring","href":"/support"}]},{"group":"Platform","icon":"grid-2","pages":[{"title":"MCP Servers","icon":"plug","href":"/mcp-servers"},{"title":"StateSet Overview","icon":"eye","iconType":"solid","href":"/stateset-overview"},{"title":"StateSet Agent Operations Architecture","href":"/stateset-agentic-os"},{"title":"Global Commerce Architecture","href":"/global-commerce-architecture"},{"title":"Autonomous Agent Architecture","href":"/autonomous-agent-architecture"},{"title":"StateSet Billing","href":"/stateset-billing"},{"title":"Security \u0026 Compliance","icon":"shield","iconType":"solid","href":"/security"},{"title":"Service-as-a-Software (SaaS 3.0)","icon":"brain","iconType":"solid","href":"/service-as-a-software"}]},{"group":"Using the APIs","icon":"briefcase","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"Host status","href":"/api-reference/hosts"},{"title":"Errors across the engines","href":"/api-reference/errors-across-engines"},{"title":"Authentication","icon":"shield-halved","iconType":"solid","href":"/api-reference/authentication"},{"title":"API Design Guidelines","icon":"book","href":"/api-reference/api-design-guidelines"},{"title":"Overview","icon":"desktop","iconType":"solid","href":"/api-reference/overview"},{"title":"Getting Started","icon":"browser","iconType":"solid","href":"/api-reference/getting-started"},{"group":"Architecture","pages":[{"title":"Web Framework","icon":"browser","iconType":"solid","href":"/api-reference/framework"},{"title":"StateSet API","href":"/api-reference/backend-framework"},{"title":"gRPC","icon":"route","iconType":"solid","href":"/api-reference/grpc-framework"},{"title":"Workflow Framework with Temporal","icon":"arrow-progress","iconType":"solid","href":"/api-reference/temporal"},{"title":"Event-Driven APIs with StateSet One","icon":"webhook","iconType":"solid","href":"/api-reference/events"}]},{"title":"Features","href":"/api-reference/features"},{"title":"Reporting and Reconciliation","icon":"file-chart-column","href":"/api-reference/reporting"},{"title":"Integrations","icon":"plug","iconType":"solid","href":"/api-reference/integrations"},{"title":"API Changelog","icon":"clock-rotate-left","iconType":"solid","href":"/api-reference/changelog"}]},{"group":"StateSet Response","icon":"comments","pages":[{"title":"ResponseCX Platform","href":"/stateset-response/responsecx-platform"},{"title":"Chat Desk","sidebarTitle":"Chat Desk","icon":"inbox","href":"/stateset-response/chat-desk"},{"title":"Your First Shift in Chat Desk","sidebarTitle":"First desk shift","icon":"inbox","href":"/guides/chat-desk-first-shift"},{"title":"Connect the Chat Widget to Your Desk","sidebarTitle":"Widget to desk","icon":"messages-square","href":"/stateset-response/chat-desk-widget"},{"title":"Chat Desk Across Channels","sidebarTitle":"Desk channel coverage","icon":"network","href":"/stateset-response/chat-desk-channels"},{"title":"Autonomy dial","href":"/stateset-response/responsecx-autonomy"},{"title":"Workflow Studio","href":"/stateset-response/responsecx-workflow-studio"},{"title":"Website Onboarding","href":"/stateset-response/responsecx-website-onboarding"},{"title":"ResponseCX API","href":"/response-api-reference/overview"},{"title":"Agents","href":"/response-api-reference/agents"},{"title":"Authentication","icon":"key","iconType":"solid","href":"/response-api-reference/authentication"},{"title":"Models","href":"/response-api-reference/models"},{"title":"Agent Framework and SDK","href":"/response-api-reference/framework"},{"title":"Computer Use","href":"/response-api-reference/computer-use"},{"title":"ReasonCX","href":"/response-api-reference/reason"},{"title":"Realtime Voice","href":"/response-api-reference/voice"},{"title":"Response Public API (v1)","href":"/stateset-response/response-public-api"},{"title":"Response MCP Servers","href":"/stateset-response/response-mcp"},{"title":"Response ChatGPT App Guide","href":"/stateset-response/stateset-response-chatgpt-guide"},{"title":"Onsite Chat Quickstart","href":"/stateset-response/response-chat-widget-quickstart"},{"title":"Response Chat Widget","href":"/stateset-response/response-chat-widget"},{"title":"Widget Authentication and Conversation Recovery","sidebarTitle":"Auth and recovery","href":"/stateset-response/response-chat-widget-reliability"},{"title":"Native Widget Live Chat","sidebarTitle":"Native live chat","href":"/stateset-response/response-chat-widget-live-chat"},{"title":"Widget Sites, Configuration and MCP","sidebarTitle":"Sites and admin","href":"/stateset-response/response-chat-widget-admin"},{"title":"Deploy and Qualify the Onsite Widget","sidebarTitle":"Deployment","href":"/stateset-response/response-chat-widget-deployment"}]},{"group":"StateSet ResponseCX","icon":"headset","pages":[{"title":"Set up ResponseCX","href":"/stateset-response/stateset-responsecx"},{"title":"ResponseCX Platform","href":"/stateset-response/responsecx-platform"},{"title":"Autonomy dial","href":"/stateset-response/responsecx-autonomy"},{"title":"ResponseCX Workflows","href":"/stateset-response/stateset-responsecx-workflows"},{"title":"StateSet ResponseCX CLI","href":"/stateset-responsecx-cli"}]},{"group":"Temporal Engine","icon":"diagram-project","pages":[{"title":"Temporal Engine","href":"/next-temporal/overview"},{"title":"Start Automating Responses","href":"/next-temporal/getting-started"},{"title":"ResponseAutomationV2","href":"/next-temporal/workflow"},{"title":"Active-horizon agents","href":"/next-temporal/active-horizon-agents"},{"title":"Connectors \u0026 Capabilities","href":"/next-temporal/connectors"},{"title":"Policy Engine \u0026 Decision Gate","href":"/next-temporal/policy-engine"},{"title":"Control Plane","href":"/next-temporal/control-plane"},{"title":"Configuration","href":"/next-temporal/configuration"},{"title":"Workstream MCP","href":"/next-temporal/mcp-connector"},{"title":"Operations","href":"/next-temporal/operations"},{"title":"Kubernetes Deployment","href":"/next-temporal/kubernetes-deployment"},{"title":"Runbooks","href":"/next-temporal/runbooks"}]},{"group":"StateSet iCommerce Engine","icon":"shopping-bag","pages":[{"group":"Overview","pages":[{"title":"iCommerce Quickstart","href":"/stateset-icommerce/stateset-icommerce-quickstart"},{"title":"The Embedded iCommerce Engine","href":"/stateset-icommerce/stateset-icommerce-embedded"},{"title":"Governed Execution and Replay","href":"/stateset-icommerce/governed-execution"},{"title":"Physical Stock Fulfillment","href":"/stateset-icommerce/stock-fulfillment"},{"title":"Native Commerce and Inventory Simulations","href":"/stateset-icommerce/simulations"},{"title":"Build an iCommerce Storefront","href":"/stateset-icommerce/storefront"},{"title":"HTTP Retry Receipts and Reconciliation","href":"/stateset-icommerce/http-receipt-recovery"},{"title":"iCommerce Scenarios and Examples","href":"/stateset-icommerce/stateset-icommerce-scenarios"},{"title":"iCommerce Language Bindings","href":"/stateset-icommerce/stateset-icommerce-bindings"},{"title":"iCommerce Paper","href":"/icommerce-paper"},{"title":"iCommerce Intro","href":"/icommerce"},{"title":"StateSet iCommerce Engine Architecture","href":"/icommerce-architecture"},{"title":"iCommerce Quickstart for AI Agents","href":"/stateset-icommerce-quickstart"},{"title":"StateSet iCommerce Engine Skills","href":"/stateset-icommerce/stateset-icommerce-skills"},{"title":"iCommerce MCP Server","href":"/stateset-icommerce/stateset-icommerce-mcp"}]},{"group":"Agent Sandbox","pages":[{"title":"iCommerce Agent Execution","href":"/stateset-icommerce/stateset-icommerce-agent"},{"title":"Run iCommerce Inside Sandbox","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox"},{"title":"Agent Sandbox Costs","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-costs"},{"title":"iCommerce Sandbox Runbook","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-runbook"},{"title":"iCommerce Sandbox Troubleshooting","href":"/stateset-icommerce/stateset-icommerce-agent-sandbox-troubleshooting"}]},{"group":"Lifecycle \u0026 Workflows","pages":[{"title":"Order Lifecycle","href":"/stateset-icommerce/stateset-icommerce-order-lifecycle"},{"title":"Returns Workflow","href":"/stateset-icommerce/stateset-icommerce-returns-workflow"},{"title":"Inventory Lifecycle","href":"/stateset-icommerce/stateset-icommerce-inventory-lifecycle"}]},{"group":"Platform \u0026 Operations","pages":[{"title":"Finance \u0026 Accounting","href":"/stateset-icommerce/stateset-icommerce-finance"},{"title":"Admin Console","href":"/stateset-icommerce/stateset-icommerce-admin"},{"title":"Commerce HTTP Access and Retry Controls","href":"/stateset-icommerce/stateset-icommerce-api-hardening"},{"title":"Backup, Restore, and Durability","href":"/stateset-icommerce/stateset-icommerce-backup-restore"}]},{"group":"CLI","pages":[{"title":"iCommerce CLI Reference","href":"/stateset-icommerce/stateset-icommerce-cli-reference"},{"title":"Operational CLI Workflows","href":"/stateset-icommerce/stateset-icommerce-cli-workflows"},{"title":"CLI and Agent Write Controls","href":"/stateset-icommerce/stateset-icommerce-cli-safety"}]},{"group":"Messaging \u0026 Payments","pages":[{"title":"Messaging Orchestrator","href":"/stateset-icommerce/stateset-icommerce-messaging-orchestrator"},{"title":"Run the WhatsApp gateway","href":"/stateset-icommerce/stateset-icommerce-whatsapp-integration"},{"title":"x402 Intents and Settlement Boundaries","href":"/stateset-icommerce/stateset-icommerce-x402-payments"},{"title":"Connect messaging channels","href":"/stateset-icommerce/stateset-icommerce-messaging-channels"}]},{"group":"Deployment","pages":[{"title":"Deploy StateSet iCommerce Engine on GCP","href":"/stateset-icommerce/stateset-icommerce-gcp"},{"title":"Deploy StateSet iCommerce Engine on Hetzner","href":"/stateset-icommerce/stateset-icommerce-hetzner"},{"title":"Deploy StateSet iCommerce Engine on Fly.io","href":"/stateset-icommerce/stateset-icommerce-flyio"}]}]},{"group":"StateSet Warehouse (WMS)","icon":"warehouse","pages":[{"title":"StateSet Warehouse (WMS)","sidebarTitle":"Overview","icon":"warehouse","href":"/stateset-warehouse/overview"},{"title":"Run StateSet Warehouse locally","sidebarTitle":"Quickstart","href":"/stateset-warehouse/quickstart"},{"title":"Warehouse REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-warehouse/api-and-mcp"},{"title":"Connect Sync OMS, Warehouse WMS, and Freight TMS","sidebarTitle":"OMS, WMS, and TMS","href":"/guides/oms-wms-tms"}]},{"group":"StateSet Freight (TMS)","icon":"truck","pages":[{"title":"StateSet Freight (TMS)","sidebarTitle":"Overview","icon":"truck","href":"/stateset-freight/overview"},{"title":"Run StateSet Freight locally","sidebarTitle":"Quickstart","href":"/stateset-freight/quickstart"},{"title":"Freight REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-freight/api-and-mcp"}]},{"group":"StateSet EDI","icon":"file-import","pages":[{"title":"StateSet EDI","href":"/stateset-edi/overview"},{"title":"Workspace Onboarding and Readiness","href":"/stateset-edi/onboarding"},{"title":"EDI Quickstart","href":"/stateset-edi/quickstart"},{"title":"Orders, Reviewed Sends, and Recovery","href":"/stateset-edi/orders-and-recovery"},{"title":"EDI Transaction Sets","href":"/stateset-edi/transaction-sets"},{"title":"EDI Transports","href":"/stateset-edi/transports"},{"title":"Guides, Mappings, and Callbacks","href":"/stateset-edi/mappings-and-callbacks"},{"title":"EDI Operations","href":"/stateset-edi/operations"},{"title":"EDI CLI and JavaScript SDK","href":"/stateset-edi/cli-and-sdk"},{"title":"EDI MCP Server","href":"/stateset-edi/mcp-server"},{"title":"EDI Configuration","href":"/stateset-edi/configuration"},{"title":"EDI Deployment and Qualification","href":"/stateset-edi/deployment-and-qualification"}]},{"group":"StateSet Mail","icon":"envelope","pages":[{"title":"StateSet Mail","href":"/stateset-mail/overview"},{"title":"Mail Quickstart","href":"/stateset-mail/quickstart"},{"title":"Conversations","href":"/stateset-mail/conversations"},{"title":"Mail MCP Server","href":"/stateset-mail/mcp-server"},{"title":"Mail Configuration","href":"/stateset-mail/configuration"}]},{"group":"StateSet iCommerce Voice Engine","icon":"phone","pages":[{"title":"StateSet iCommerce Voice Engine","href":"/stateset-voice/overview"},{"title":"Build Your First Voice Agent","href":"/stateset-voice/quickstart"},{"title":"Voice API","href":"/stateset-voice/api"},{"title":"Voice SDKs","href":"/stateset-voice/sdks"},{"title":"Voice Webhooks","href":"/stateset-voice/webhooks"},{"title":"Voice Configuration","href":"/stateset-voice/configuration"},{"title":"Voice MCP Server","href":"/stateset-voice/mcp-server"},{"title":"Voice Operations","href":"/stateset-voice/operations"}]},{"group":"StateSet iCommerce NSR Engine","icon":"brain","pages":[{"title":"Neuro-Symbolic Architecture","href":"/stateset-nsr"},{"title":"NSR-L Language Reference","href":"/stateset-nsr-l"},{"title":"Verified Decisions API","href":"/stateset-nsr-decisions"},{"title":"Jev + NSR","sidebarTitle":"Jev + NSR","icon":"scan-text","href":"/stateset-nsr-jev"},{"title":"Your First Jev + NSR Decision","sidebarTitle":"First Jev decision","icon":"play","href":"/guides/jev-first-decision"},{"title":"Jev + NSR Industry Pack Examples","sidebarTitle":"Industry examples","icon":"building","href":"/guides/jev-industry-packs"},{"title":"Use Industry Packs with the Decisions API","sidebarTitle":"Decisions API walkthrough","icon":"code","href":"/guides/jev-decisions-api"},{"title":"Connect Jev to Your NSR Workspace","sidebarTitle":"Jev workspace setup","icon":"key-round","href":"/guides/jev-workspace-setup"},{"title":"Agent Gate","href":"/stateset-nsr-agent-gate"},{"title":"Formal Verification","href":"/stateset-nsr-formal-verification"},{"title":"NSR as a Model Provider","href":"/stateset-nsr-providers"},{"title":"NSR Console \u0026 Billing","href":"/stateset-nsr-console"},{"title":"NSR SDKs","href":"/stateset-nsr-sdks"},{"title":"NSR MCP Server","href":"/stateset-nsr-mcp"}]},{"group":"AI Agents","icon":"robot","pages":[{"title":"StateSet Computer Use Agent","href":"/computer-use-agent"},{"title":"Engines and Commerce MCP Servers","href":"/computer-use-engines-mcp"},{"title":"Computer Use MCP Servers","href":"/computer-use-mcp"},{"title":"StateSet RL agents","href":"/stateset-rl-agents"}]},{"group":"StateSet Agents","pages":[{"title":"StateSet Agents","href":"/stateset-agents/overview"},{"title":"Prepare your first fine-tuning run","sidebarTitle":"Quickstart","href":"/stateset-agents/quickstart"},{"title":"Fine-tuning studio","href":"/stateset-agents/finetuning-studio"},{"title":"Fine-tuning from AI agents","href":"/stateset-agents/finetuning-agents"},{"title":"Checkpoint recovery and evaluation","href":"/stateset-agents/checkpoints-and-evaluation"},{"title":"River SFT, native RL, and retained evidence","sidebarTitle":"River training","href":"/stateset-agents/river-training"},{"title":"Industry data and fine-tuning","href":"/stateset-agents/industry-finetuning"},{"title":"StateSet Agents CLI","sidebarTitle":"CLI reference","href":"/stateset-agents/cli"},{"title":"Agents MCP server","href":"/stateset-agents/mcp-server"}]},{"group":"StateSet Sandbox","icon":"flask","pages":[{"title":"StateSet Sandbox","href":"/stateset-sandbox/stateset-sandboxes"},{"title":"Sandbox Quickstart","href":"/stateset-sandbox/stateset-sandbox-quickstart-guide"},{"title":"Get started with StateSet Swarm","href":"/stateset-sandbox/swarm-getting-started"},{"title":"Execution, workers, and recovery","href":"/stateset-sandbox/execution-and-recovery"},{"title":"Sandbox terminal workbench","href":"/stateset-sandbox/workbench"},{"title":"Prepared agent tasks and teams","href":"/stateset-sandbox/agent-tasks"},{"title":"Artifacts and recoverable tunnels","href":"/stateset-sandbox/artifacts-and-tunnels"},{"group":"Architecture \u0026 Operations","pages":[{"title":"Sandbox architecture","href":"/stateset-sandbox/stateset-sandbox-architecture"},{"title":"Sandbox operations and release evidence","href":"/stateset-sandbox/stateset-sandbox-operations"},{"title":"Sandbox webhooks and event delivery","href":"/stateset-sandbox/stateset-sandbox-webhooks"},{"title":"Sandbox security boundaries","href":"/stateset-sandbox/stateset-sandbox-security-guide"},{"title":"Sandbox API workflow","href":"/stateset-sandbox/stateset-sandbox-api-flow"},{"title":"Durable sandboxes and agent sessions","href":"/stateset-sandbox/stateset-sandbox-agent-sessions"},{"title":"Self-host Sandbox","href":"/stateset-sandbox/stateset-sandbox-deployments"},{"title":"Sandbox API directory","href":"/stateset-sandbox/stateset-sandbox-api-reference"},{"title":"Sandbox production configuration","href":"/stateset-sandbox/stateset-sandbox-production-guide"},{"title":"Sandbox Quickstart","href":"/stateset-sandbox/stateset-sandbox-quickstart-guide"},{"title":"Sandbox runtime selection","href":"/stateset-sandbox/stateset-sandbox-runtime-selection"},{"title":"Sandbox on AWS EKS","href":"/stateset-sandbox/stateset-sandbox-deployment-aws"},{"title":"Sandbox on GCP GKE","href":"/stateset-sandbox/stateset-sandbox-deployment-gcp"},{"title":"Sandbox on Azure AKS","href":"/stateset-sandbox/stateset-sandbox-deployment-azure"},{"title":"Sandbox MCP server","href":"/stateset-sandbox/stateset-sandbox-mcp"}]},{"group":"SDKs","pages":[{"title":"Sandbox TypeScript SDK","sidebarTitle":"Node.js SDK","href":"/stateset-sandbox/stateset-sandbox-sdk-node"},{"title":"Sandbox Python SDK","href":"/stateset-sandbox/stateset-sandbox-sdk-python"}]},{"title":"Build with StateSet Sandbox","href":"/guides/stateset-sandbox"}]},{"group":"StateSet ACP","icon":"bolt","pages":[{"title":"Agentic Commerce Protocol","href":"/stateset-acp/stateset-acp"},{"title":"ACP Overview","href":"/stateset-acp/stateset-acp-overview"},{"title":"ACP Quickstart","href":"/stateset-acp/stateset-acp-quickstart"},{"group":"Reference","pages":[{"title":"ACP Async Processing","href":"/stateset-acp/stateset-acp-async-processing"},{"title":"ACP API Endpoints","href":"/stateset-acp/stateset-acp-endpoints"},{"title":"ACP Routing Options","href":"/stateset-acp/stateset-acp-routing"},{"title":"ACP Request Schemas","href":"/stateset-acp/stateset-acp-schemas"}]},{"title":"Agentic Commerce Protocol Handler","href":"/guides/agentic-commerce-protocol-handler"},{"title":"Agentic Commerce Protocol Checkout Guide","href":"/agentic-commerce/agentic-commerce-checkout-guide"}]},{"group":"StateSet UCP","icon":"arrows-split-up-and-left","pages":[{"title":"Universal Commerce Protocol","href":"/stateset-ucp"},{"title":"UCP Quickstart","href":"/stateset-ucp-quickstart"},{"title":"Universal Commerce Protocol Handler","href":"/guides/universal-commerce-protocol-handler"}]},{"group":"StateSet ICP","icon":"network-wired","pages":[{"title":"Intelligent Commerce Protocol (ICP)","href":"/stateset-icp"}]},{"group":"StateSet Sequencer","icon":"layer-group","pages":[{"title":"StateSet VES System Overview","href":"/stateset-sequencer/stateset-sequencer"},{"title":"Sequencer Architecture: Deep Dive","href":"/stateset-sequencer-architecture"},{"title":"Sequencer Quickstart","href":"/stateset-sequencer/stateset-sequencer-quickstart"},{"title":"Sequencer Operations","href":"/stateset-sequencer/stateset-sequencer-operations"},{"title":"x402 payments reference","href":"/stateset-sequencer/stateset-sequencer-x402"}]},{"group":"StateSet Set L2","icon":"cube","pages":[{"title":"Set L2","href":"/set/set"},{"title":"StateSet Set L2","href":"/set/stateset-set-l2"},{"title":"Set L2 Architecture","href":"/set/stateset-set-l2-architecture"},{"title":"Set L2 Verification","href":"/set/stateset-set-l2-verification"},{"title":"Set L2 Verification Example","href":"/set/stateset-set-l2-verification-example"},{"title":"Set L2 Compliance Proofs","href":"/set/stateset-set-l2-compliance-proof"},{"title":"STARK Compliance Proofs","href":"/set/stateset-stark"}]},{"group":"StateSet Cloud","icon":"cloud","pages":[{"title":"StateSet Cloud Overview","href":"/cloud-api-reference/overview"},{"title":"Authentication","href":"/cloud-api-reference/authentication"},{"title":"API Keys","href":"/cloud-api-reference/api-keys"},{"group":"Cloud API","pages":[{"group":"Projects","pages":[{"title":"Create Projects","api":"POST https://api.stateset.com/v1/projects","href":"/cloud-api-reference/projects/create"},{"title":"Delete Project","api":"DELETE https://api.stateset.com/v1/projects/{id}","href":"/cloud-api-reference/projects/delete"},{"title":"Get Projects","api":"GET https://api.stateset.com/v1/projects","href":"/cloud-api-reference/projects/get"}]},{"group":"Deployments","pages":[{"title":"Create Deployment","api":"POST https://api.stateset.com/v1/deployments","href":"/cloud-api-reference/deployments/create"},{"title":"Delete Deployment","api":"DELETE https://api.stateset.com/v1/deployments/{id}","href":"/cloud-api-reference/deployments/delete"},{"title":"Get Deployments","api":"GET https://api.stateset.com/v1/deployments","href":"/cloud-api-reference/deployments/get"}]},{"group":"Secrets","pages":[{"title":"Create Secrets","api":"POST https://api.stateset.com/v1/secrets","href":"/cloud-api-reference/secrets/create"},{"title":"Delete Secret","api":"DELETE https://api.stateset.com/v1/secrets/{id}","href":"/cloud-api-reference/secrets/delete"},{"title":"Get Secrets","api":"GET https://api.stateset.com/v1/secrets","href":"/cloud-api-reference/secrets/get"},{"title":"Update Secrets","api":"PUT https://api.stateset.com/v1/secrets/{id}","href":"/cloud-api-reference/secrets/update"}]},{"group":"Logs","pages":[{"title":"Create Logs","api":"POST https://api.stateset.com/v1/logs","href":"/cloud-api-reference/logs/create"},{"title":"Get Logs","api":"GET https://api.stateset.com/v1/logs","href":"/cloud-api-reference/logs/get"}]},{"group":"Templates","pages":[{"title":"Create Template","api":"POST https://api.stateset.com/v1/templates","href":"/cloud-api-reference/templates/create"},{"title":"Delete Template","api":"DELETE https://api.stateset.com/v1/templates/{id}","href":"/cloud-api-reference/templates/delete"},{"title":"Get Templates","api":"GET https://api.stateset.com/v1/templates","href":"/cloud-api-reference/templates/get"},{"title":"Update Template","api":"PUT https://api.stateset.com/v1/templates/{id}","href":"/cloud-api-reference/templates/update"}]}]}]},{"group":"Apps \u0026 Consoles","pages":[{"title":"StateSet Console","href":"/stateset-console/stateset-console-overview"},{"title":"Get Started with Console on the Web","sidebarTitle":"Web Console quickstart","icon":"globe","href":"/guides/console-web-getting-started"},{"title":"Get Started with Console on Mobile","sidebarTitle":"Mobile Console quickstart","icon":"mobile-screen","href":"/guides/console-mobile-getting-started"},{"title":"Get Started with StateSet Desktop","sidebarTitle":"Desktop quickstart","icon":"monitor","href":"/guides/desktop-getting-started"},{"title":"StateSet Demo App","href":"/stateset-demo-app-overview"},{"title":"StateSet Worker","href":"/stateset-worker"},{"title":"Console Mobile","href":"/stateset-console/stateset-console-mobile"},{"title":"StateSet Desktop","href":"/stateset-desktop"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"StateSet iCommerce CLI","href":"/stateset-cli-overview"},{"title":"Console Agent Pipeline","href":"/stateset-console/stateset-console-agent-pipeline"},{"title":"Console Auth Flow","href":"/stateset-console/stateset-console-auth-flow"},{"title":"Deploy the ACP Handler","href":"/stateset-deploy-acp-handler"},{"title":"Sync Server: What's New","href":"/stateset-sync-server-whats-new"},{"title":"Sync Server MCP","href":"/stateset-sync-mcp"},{"title":"Sync Server API Basics","href":"/stateset-sync-server-api-basics"},{"title":"StateSet Deploy","href":"/stateset-deploy-overview"},{"title":"Deploy the Response ChatGPT App","href":"/stateset-deploy-chatgpt-app"},{"title":"Sync Server gRPC Dispatch Flow","href":"/stateset-sync-server-grpc-flow"},{"title":"Sync Server connectors","href":"/stateset-sync-server-connectors"},{"title":"Sync Server troubleshooting","href":"/stateset-sync-server-troubleshooting"},{"title":"iCommerce Agent Operating Guide","href":"/stateset-icommerce-skill"},{"title":"Sandbox agent operating guide","href":"/stateset-sandbox-skill"},{"title":"Sync Server API Contract","href":"/stateset-sync-server-api-contract"},{"title":"Sync Server ACP Guide","href":"/stateset-sync-server-acp-guide"},{"title":"Sync Server gRPC Dispatch","href":"/stateset-sync-server-grpc-dispatch"}]}]},{"tab":"Guides","icon":"graduation-cap","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"SDK Installation and Setup","icon":"code","href":"/guides/sdk-installation"}]},{"group":"Quickstarts","icon":"play","pages":[{"title":"ResponseCX","href":"/guides/response-quickstart"},{"title":"Warranty Claims Quickstart","icon":"right-left","iconType":"solid","href":"/guides/warranties-quickstart"},{"title":"Customers Quickstart","icon":"user","href":"/guides/customers-quickstart"},{"title":"Agentic Commerce Protocol Checkout Guide","href":"/agentic-commerce/agentic-commerce-checkout-guide"},{"title":"StateSet Cloud Quickstart","icon":"cloud","iconType":"solid","href":"/guides/stateset-cloud-quickstart"},{"title":"Onsite Chat Quickstart","href":"/stateset-response/response-chat-widget-quickstart"}]},{"group":"End-to-end","icon":"route","pages":[{"title":"Launch a brand that runs itself","href":"/guides/launch-a-brand-autonomously"},{"title":"EDI Order to Cash Across StateSet","href":"/guides/journey-edi-order-to-cash"},{"title":"From 'where is my order?' to a closed operation","href":"/guides/journey-wismo-to-resolution"},{"title":"Sync a Shopify store with NetSuite","href":"/guides/sync-shopify-to-netsuite"},{"title":"Your First EDI Purchase-Order Cycle","href":"/guides/edi-first-850"},{"title":"Gate a refund with a verified decision","href":"/guides/nsr-first-verified-decision"},{"title":"Run a durable order workflow end to end","href":"/guides/temporal-first-durable-workflow"},{"title":"Automate a back-office tool that has no API","href":"/guides/computer-use-first-task"},{"title":"Put an agent on the phone","href":"/guides/voice-first-phone-agent"},{"title":"Your first Sandbox runtime workflow","href":"/guides/sandbox-first-runtime"}]},{"group":"Commerce Workflows","icon":"diagram-project","pages":[{"title":"Order to cash","href":"/guides/commerce/order-to-cash"},{"title":"AR and collections","href":"/guides/commerce/ar-collections"},{"title":"Period close","href":"/guides/commerce/period-close"},{"title":"Procure to pay","href":"/guides/commerce/procure-to-pay"},{"title":"Receiving and Put-away","href":"/guides/commerce/receiving-and-putaway"},{"title":"Fulfillment \u0026 Shipping","href":"/guides/commerce/fulfillment"},{"title":"Returns and return-to-vendor","href":"/guides/commerce/returns-and-rtv"},{"title":"Lot and serial traceability","href":"/guides/commerce/traceability"}]},{"group":"Order Management","icon":"shopping-cart","pages":[{"title":"Orders Quickstart","href":"/guides/orders-quickstart"},{"title":"Payments \u0026 Refunds Quickstart","href":"/guides/payments-quickstart"},{"title":"Order Settlements Quickstart","icon":"gears","iconType":"solid","href":"/guides/order-settlement"},{"title":"Wholesale Quickstart","icon":"cart-shopping","iconType":"solid","href":"/guides/wholesale-quickstart"},{"title":"Order Operations","href":"/guides/order-operations"}]},{"group":"Returns \u0026 Warranties","icon":"rotate-left","pages":[{"title":"Returns Quickstart","href":"/guides/returns-quickstart"},{"title":"Warranty Vision Workflow User Guide","icon":"brain","iconType":"solid","href":"/guides/warranty-vision-guide"}]},{"group":"Supply Chain","icon":"truck","pages":[{"title":"Manufacturing Quickstart","href":"/guides/manufacturing-quickstart"},{"title":"Warehouse Receiving Quickstart","icon":"warehouse","href":"/guides/warehouse-quickstart"},{"title":"Supplier \u0026 Purchase Order Quickstart","icon":"truck","iconType":"solid","href":"/guides/supplier-quickstart"},{"title":"Inventory Quickstart","href":"/guides/inventory-quickstart"},{"title":"COGS","href":"/guides/cogs-quickstart"}]},{"group":"Agent Development","icon":"robot","pages":[{"title":"Agents Quickstart","icon":"message-bot","iconType":"solid","href":"/guides/agents-quickstart"},{"title":"Agent Training Guide","icon":"graduation-cap","iconType":"solid","href":"/guides/agent-trainer-guide"},{"title":"Agent Objectives, Goals, Metrics \u0026 Rewards Guide","icon":"brain","iconType":"solid","href":"/guides/agent-objectives-guide"},{"title":"Multi-Agent System Architectures","icon":"brain","iconType":"solid","href":"/guides/multi-agent-systems"},{"title":"StateSet Computer Use Agents - Quick Start Guide","icon":"brain","iconType":"solid","href":"/guides/stateset-computer-use-agents"},{"title":"StateSet Computer Use Agents - Architecture Overview","icon":"brain","iconType":"solid","href":"/guides/stateset-computer-use-agents-architecture"},{"title":"Reinforcement learning and fine-tuning","href":"/guides/reinforcement-learning-platform"},{"title":"GRPO and the StateSet training framework","sidebarTitle":"GRPO framework","href":"/guides/grpo-agent-framework"},{"title":"MCP Integration for AI Agents","icon":"plug","iconType":"solid","href":"/guides/mcp-integration-guide"}]},{"group":"Knowledge \u0026 RAG","icon":"brain","pages":[{"title":"Knowledge Base Quickstart","icon":"brain","iconType":"solid","href":"/guides/knowledgebase-quickstart"},{"title":"RAG Quickstart","icon":"wand-magic-sparkles","iconType":"solid","href":"/guides/rag-quickstart"},{"title":"Sources Quickstart","icon":"database","iconType":"solid","href":"/guides/sources-quickstart"}]},{"group":"Response Features","icon":"wand-magic-sparkles","pages":[{"title":"Agent Attributes \u0026 Personality","icon":"palette","iconType":"solid","href":"/guides/attributes-quickstart"},{"title":"Agent Rules Quickstart","icon":"scale-balanced","iconType":"solid","href":"/guides/rules-quickstart"},{"title":"Examples Quickstart","icon":"lightbulb","iconType":"solid","href":"/guides/examples-quickstart"},{"title":"Evaluations Guide","sidebarTitle":"Evaluations","icon":"clipboard-check","href":"/guides/evaluations-guide"},{"title":"Agent Schedules \u0026 Automation","icon":"clock","iconType":"solid","href":"/guides/schedules-quickstart"},{"title":"Agent Functions Quickstart","icon":"plug","iconType":"solid","href":"/guides/functions-quickstart"}]},{"group":"Advanced Features","icon":"flask","pages":[{"title":"Vision Quickstart","icon":"eye","iconType":"solid","href":"/guides/vision-quickstart"},{"title":"Voice AI Guide","icon":"microphone","iconType":"solid","href":"/guides/voice-quickstart"},{"title":"Synthetic Fixtures for Agent Testing","icon":"brain","href":"/guides/synthetic-data"},{"title":"StateSet Synthetic Data Studio Architecture Guide","icon":"diagram-project","iconType":"solid","href":"/guides/synthetic-data-architecture"}]},{"group":"Integrations","icon":"plug","pages":[{"title":"Shopify Product Embeddings","icon":"shopify","iconType":"solid","href":"/guides/shopify-quickstart"},{"title":"Gorgias Ticket Quickstart","icon":"ticket","iconType":"solid","href":"/guides/gorgias-quickstart"},{"title":"Multi-Channel Commerce Integration Guide","icon":"store","iconType":"solid","href":"/guides/multi-channel-integration-guide"}]},{"group":"Commerce Network","icon":"link","pages":[{"title":"StateSet Network Quickstart","icon":"globe","iconType":"solid","href":"/guides/stateset-network"},{"title":"Commerce Network Orders: Migration Guide","href":"/guides/stateset-network-orders"},{"title":"StateSet Contracts","icon":"file-contract","iconType":"solid","href":"/guides/stateset-contracts"},{"title":"Agent Payments: Build and Verify","href":"/guides/smart-agents-usdc-guide"},{"title":"Complete an x402 payment","href":"/stateset-x402-walkthrough"},{"title":"CCTP Integration: Availability and Prerequisites","href":"/guides/cctp-module-integration"},{"title":"Agent Payments and Legacy Network Examples","href":"/smart-agents-usdc-guide"}]},{"group":"Self-Hosted","icon":"server","pages":[{"title":"Build with StateSet Sandbox","href":"/guides/stateset-sandbox"},{"title":"Agentic Commerce Protocol Handler","href":"/guides/agentic-commerce-protocol-handler"},{"title":"Universal Commerce Protocol Handler","href":"/guides/universal-commerce-protocol-handler"}]},{"group":"Best Practices","icon":"shield-check","pages":[{"title":"Error Handling \u0026 Retries","icon":"triangle-exclamation","href":"/guides/error-handling-best-practices"},{"title":"Handle Rate Limits Without Losing Requests","icon":"gauge-high","href":"/guides/api-rate-limiting"},{"title":"Performance Optimization Guide","icon":"rocket","iconType":"solid","href":"/guides/performance-optimization"},{"title":"Integration Test Plan","icon":"flask","href":"/guides/comprehensive-testing-guide"},{"title":"Integration Testing","icon":"flask","href":"/guides/api-testing"},{"title":"Batch Operations Guide","icon":"cogs","iconType":"solid","href":"/guides/batch-operations"},{"title":"Webhook Security Guide","icon":"shield","iconType":"solid","href":"/guides/webhook-security"}]},{"group":"E-commerce Workflows","icon":"cart-shopping","pages":[{"title":"Ecommerce Agent Workflows Guide","icon":"gears","href":"/guides/ecommerce-agent-workflows-guide"}]}]}]},{"dropdown":"API Reference","icon":"code","description":"Every endpoint, with a playground","tabs":[{"tab":"iCommerce","icon":"shopping-cart","pages":[{"title":"iCommerce","href":"/api-reference/commerce/overview"}]},{"tab":"ResponseCX","icon":"headset","pages":[{"title":"ResponseCX","href":"/api-reference/responsecx/overview"}]},{"tab":"Chat Widget","icon":"message-square","pages":[{"title":"Chat Widget","href":"/api-reference/chat-widget/overview"}]},{"tab":"Voice","icon":"phone","pages":[{"title":"Voice","href":"/api-reference/voice/overview"}]},{"tab":"Sandbox","icon":"box","groups":[{"group":"Overview","pages":[{"title":"Sandbox core API","href":"/api-reference/sandbox/overview"}]},{"group":"Sandboxes","pages":[{"title":"Register a new organization","api":"POST https://api.sandbox.stateset.app/api/v1/register","description":"Organization registered; verify email before creating a usable API key. Registration does not provision a runtime.","href":"/api-reference/sandbox/register-create"},{"title":"List sandboxes for the authenticated organization","api":"GET https://api.sandbox.stateset.app/api/v1/sandboxes","href":"/api-reference/sandbox/sandboxes-list"}]},{"group":"Create","pages":[{"title":"Create a new sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/create","description":"Sandbox created successfully","href":"/api-reference/sandbox/sandbox-create-create"},{"title":"Create sandbox from a template","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/create-from-template","href":"/api-reference/sandbox/sandbox-create-from-template-create"}]},{"group":"Lifecycle","pages":[{"title":"Delete a sandbox (alias for stop)","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}","href":"/api-reference/sandbox/sandbox-by-delete"},{"title":"Extend sandbox expiration window","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/extend","href":"/api-reference/sandbox/sandbox-by-extend-create"},{"title":"Get sandbox details","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}","href":"/api-reference/sandbox/sandbox-by-get"},{"title":"Pause a running sandbox (snapshot mode: durable only; filesystem kept, memory…","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause","href":"/api-reference/sandbox/sandbox-by-pause-create"},{"title":"Resume a paused sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/resume","href":"/api-reference/sandbox/sandbox-by-resume-create"},{"title":"Get sandbox status (lightweight)","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/status","href":"/api-reference/sandbox/sandbox-by-status-get"},{"title":"Stop and delete a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/stop","href":"/api-reference/sandbox/sandbox-by-stop-create"}]},{"group":"Execute","pages":[{"title":"Execute a command in a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/execute","href":"/api-reference/sandbox/sandbox-by-execute-create"},{"title":"Get execution details","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}","href":"/api-reference/sandbox/sandbox-by-executions-by-get"},{"title":"Stream execution output via SSE","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}/stream","href":"/api-reference/sandbox/sandbox-by-executions-by-stream-get"},{"title":"List executions for a sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions","href":"/api-reference/sandbox/sandbox-by-executions-get"}]},{"group":"Files","pages":[{"title":"Copy a file or directory","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/copy","href":"/api-reference/sandbox/sandbox-by-files-copy-create"},{"title":"Delete a file or directory from the sandbox","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-delete"},{"title":"Download a file from sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/download","href":"/api-reference/sandbox/sandbox-by-files-download-get"},{"title":"Read a file from a sandbox","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-get"},{"title":"Find files matching a glob pattern","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/glob","href":"/api-reference/sandbox/sandbox-by-files-glob-create"},{"title":"List files in a sandbox directory","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/list","href":"/api-reference/sandbox/sandbox-by-files-list-get"},{"title":"Create a directory in the sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/mkdir","href":"/api-reference/sandbox/sandbox-by-files-mkdir-create"},{"title":"Move or rename a file","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/move","href":"/api-reference/sandbox/sandbox-by-files-move-create"},{"title":"Watch for file changes via SSE","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files/watch","href":"/api-reference/sandbox/sandbox-by-files-watch-get"},{"title":"Write files to a sandbox","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/files","href":"/api-reference/sandbox/sandbox-by-files-create"}]},{"group":"Desktop","pages":[{"title":"Perform a keyboard action (type, key, hotkey)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/keyboard","href":"/api-reference/sandbox/sandbox-by-keyboard-create"},{"title":"Perform a mouse action (click, move, drag, double-click)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/mouse","href":"/api-reference/sandbox/sandbox-by-mouse-create"},{"title":"Get screen dimensions of the sandbox desktop","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screen","href":"/api-reference/sandbox/sandbox-by-screen-get"},{"title":"Capture a screenshot with options (format, quality, region)","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot","href":"/api-reference/sandbox/sandbox-by-screenshot-create"},{"title":"Capture a screenshot of the sandbox desktop","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot","href":"/api-reference/sandbox/sandbox-by-screenshot-get"}]},{"group":"Tunnels","pages":[{"title":"Create a tunnel","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/tunnels","href":"/api-reference/sandbox/sandbox-by-tunnels-create"},{"title":"List tunnels","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/tunnels","href":"/api-reference/sandbox/sandbox-by-tunnels-get"},{"title":"Close a tunnel","api":"DELETE https://api.sandbox.stateset.app/api/v1/tunnels/{id}","href":"/api-reference/sandbox/tunnels-by-delete"}]},{"group":"Inference","pages":[{"title":"Proxy an LLM inference request","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/inference","href":"/api-reference/sandbox/sandbox-by-inference-create"}]},{"group":"Secrets","pages":[{"title":"Delete a secret","api":"DELETE https://api.sandbox.stateset.app/api/v1/secrets/{name}","href":"/api-reference/sandbox/secrets-by-delete"},{"title":"Update a secret","api":"PUT https://api.sandbox.stateset.app/api/v1/secrets/{name}","href":"/api-reference/sandbox/secrets-by-update"},{"title":"Create a new secret","api":"POST https://api.sandbox.stateset.app/api/v1/secrets","href":"/api-reference/sandbox/secrets-create"},{"title":"List secrets","api":"GET https://api.sandbox.stateset.app/api/v1/secrets","href":"/api-reference/sandbox/secrets-list"}]},{"group":"API keys","pages":[{"title":"Revoke an API key","api":"DELETE https://api.sandbox.stateset.app/api/v1/api-keys/{id}","href":"/api-reference/sandbox/api-keys-by-delete"},{"title":"Create a new API key","api":"POST https://api.sandbox.stateset.app/api/v1/api-keys","href":"/api-reference/sandbox/api-keys-create"},{"title":"List API keys","api":"GET https://api.sandbox.stateset.app/api/v1/api-keys","href":"/api-reference/sandbox/api-keys-list"}]},{"group":"Usage","pages":[{"title":"Get current billing period usage","api":"GET https://api.sandbox.stateset.app/api/v1/usage/current","href":"/api-reference/sandbox/usage-current-list"},{"title":"Get usage history","api":"GET https://api.sandbox.stateset.app/api/v1/usage/history","href":"/api-reference/sandbox/usage-history-list"}]},{"group":"Webhooks","pages":[{"title":"Register a webhook endpoint","api":"POST https://api.sandbox.stateset.app/api/v1/webhooks","href":"/api-reference/sandbox/webhooks-create"},{"title":"List registered webhooks","api":"GET https://api.sandbox.stateset.app/api/v1/webhooks","href":"/api-reference/sandbox/webhooks-list"}]},{"group":"System","pages":[{"title":"Public service status (no auth required)","api":"GET https://api.sandbox.stateset.app/api/status","href":"/api-reference/sandbox/api-status-list"},{"title":"Health check","api":"GET https://api.sandbox.stateset.app/health","href":"/api-reference/sandbox/health-list"},{"title":"Readiness check","api":"GET https://api.sandbox.stateset.app/ready","href":"/api-reference/sandbox/ready-list"}]},{"group":"History","pages":[{"title":"Sandbox API history","href":"/api-reference/sandbox/history"}]},{"group":"Processes","pages":[{"title":"Kill a supervised process (TERM, then KILL after grace_seconds) and stop…","api":"DELETE https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}","href":"/api-reference/sandbox/sandbox-by-processes-by-delete"},{"title":"Get a supervised process","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}","href":"/api-reference/sandbox/sandbox-by-processes-by-get"},{"title":"Read or follow a process log by absolute byte offset","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/logs","href":"/api-reference/sandbox/sandbox-by-processes-by-logs-get"},{"title":"Read a bounded worker result; incomplete snapshots are safe to read again","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/result","href":"/api-reference/sandbox/sandbox-by-processes-by-result-get"},{"title":"Signal a supervised process group","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/signal","href":"/api-reference/sandbox/sandbox-by-processes-by-signal-create"},{"title":"Write to a supervised process stdin","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes/{processId}/stdin","href":"/api-reference/sandbox/sandbox-by-processes-by-stdin-create"},{"title":"Start a supervised background process","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes","href":"/api-reference/sandbox/sandbox-by-processes-create"},{"title":"List supervised processes","api":"GET https://api.sandbox.stateset.app/api/v1/sandbox/{id}/processes","href":"/api-reference/sandbox/sandbox-by-processes-get"}]},{"group":"Task registry","pages":[{"title":"Read server-registered task metadata","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}","href":"/api-reference/sandbox/agent-tasks-by-get"},{"title":"Root owner revokes a task-family grant","api":"DELETE https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants/{principal}","href":"/api-reference/sandbox/agent-tasks-by-grants-by-delete"},{"title":"Root owner reviews current task-family access grants","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants","href":"/api-reference/sandbox/agent-tasks-by-grants-get"},{"title":"Root owner grants viewer or operator access to the task family","api":"PUT https://api.sandbox.stateset.app/api/v1/agent-tasks/{taskId}/grants","href":"/api-reference/sandbox/agent-tasks-by-grants-update"},{"title":"Register private task metadata with server-checked parent lineage","api":"POST https://api.sandbox.stateset.app/api/v1/agent-tasks","href":"/api-reference/sandbox/agent-tasks-create"},{"title":"List only task families this principal can read","api":"GET https://api.sandbox.stateset.app/api/v1/agent-tasks","href":"/api-reference/sandbox/agent-tasks-list"}]},{"group":"Recovery and branching","pages":[{"title":"Request process-group cancellation from any controller replica","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}/cancel","href":"/api-reference/sandbox/sandbox-by-executions-by-cancel-create"},{"title":"Fork a sandbox from a durable checkpoint","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/fork","href":"/api-reference/sandbox/sandbox-by-fork-create"},{"title":"Restore a sandbox into a different isolation tier","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/{id}/promote","href":"/api-reference/sandbox/sandbox-by-promote-create"},{"title":"Delegate a subset of sandbox scopes for at most five minutes","api":"POST https://api.sandbox.stateset.app/api/v1/sandbox/self/token","href":"/api-reference/sandbox/sandbox-self-token-create"}]}]},{"tab":"Sync Server","icon":"refresh-cw","pages":[{"title":"Sync Server","href":"/api-reference/sync/overview"}]},{"tab":"Temporal Engine","icon":"workflow","pages":[{"title":"Temporal Engine","href":"/api-reference/temporal/overview"}]},{"tab":"EDI","icon":"file-text","pages":[{"title":"EDI","href":"/api-reference/edi/overview"}]},{"tab":"NSR","icon":"brain","pages":[{"title":"NSR","href":"/api-reference/nsr/overview"}]},{"tab":"Computer Use","icon":"monitor","pages":[{"title":"Computer Use","href":"/api-reference/computer-use/overview"}]},{"tab":"Agents","icon":"bot","pages":[{"title":"Agents","href":"/api-reference/agents/overview"}]}]},{"dropdown":"For AI Agents","icon":"bot","description":"MCP servers and skills for agents using StateSet","tabs":[{"tab":"MCP Servers","icon":"plug","groups":[{"group":"Start here","pages":[{"sidebarTitle":"Signup to first value","title":"From Signup to First Value","icon":"rocket","href":"/guides/platform-onboarding"},{"sidebarTitle":"Rust engines \u0026 MCP","title":"Build Operations with Rust Engines \u0026 MCP","icon":"cpu","href":"/guides/rust-engines-and-mcp"},{"sidebarTitle":"Connect through MCP","title":"Manage Agents \u0026 Workflows with MCP","icon":"plug","href":"/guides/manage-platform-with-mcp"},{"sidebarTitle":"Configuration changes","title":"Your First Workflow Configuration Change","icon":"git-pull-request","href":"/guides/first-workflow-config-change"},{"sidebarTitle":"Durable agents","title":"Operate Your First Durable Agent","icon":"bot","href":"/guides/first-durable-agent"},{"sidebarTitle":"Agent evaluations","title":"Your First Agent Evaluation","icon":"check-check","href":"/guides/first-agent-evaluation"},{"sidebarTitle":"Your first week","title":"Your First Week with StateSet","icon":"chart-line","href":"/guides/first-week-with-stateset"},{"sidebarTitle":"Troubleshooting","title":"Troubleshoot Your First Operation","icon":"life-ring","href":"/guides/onboarding-troubleshooting"},{"sidebarTitle":"Workflow trial","title":"Your First Workflow Trial","icon":"workflow","href":"/guides/first-workflow-trial"},{"sidebarTitle":"Agent quickstart","title":"Getting Started for AI Agents","icon":"robot","href":"/getting-started-for-ai-agents"},{"sidebarTitle":"First local operation","title":"Your First Operation","icon":"play","href":"/guides/first-operation"},{"sidebarTitle":"Connect your systems","title":"Connect Your Operation","icon":"plug","href":"/guides/connect-your-operation"},{"title":"MCP Servers","icon":"plug","href":"/mcp-servers"},{"title":"MCP Integration for AI Agents","icon":"plug","iconType":"solid","href":"/guides/mcp-integration-guide"}]},{"group":"Commerce","pages":[{"title":"iCommerce MCP Server","href":"/stateset-icommerce/stateset-icommerce-mcp"},{"title":"Sandbox MCP server","href":"/stateset-sandbox/stateset-sandbox-mcp"},{"title":"Sync Server MCP","href":"/stateset-sync-mcp"},{"title":"EDI MCP Server","href":"/stateset-edi/mcp-server"},{"title":"Warehouse REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-warehouse/api-and-mcp"},{"title":"Freight REST API and MCP","sidebarTitle":"API and MCP","href":"/stateset-freight/api-and-mcp"}]},{"group":"Customer experience","pages":[{"title":"Response MCP Servers","href":"/stateset-response/response-mcp"},{"title":"Voice MCP Server","href":"/stateset-voice/mcp-server"},{"title":"Mail MCP Server","href":"/stateset-mail/mcp-server"}]},{"group":"Decisions and automation","pages":[{"title":"NSR MCP Server","href":"/stateset-nsr-mcp"},{"title":"Workstream MCP","href":"/next-temporal/mcp-connector"},{"title":"Agents MCP server","href":"/stateset-agents/mcp-server"},{"title":"Computer Use MCP Servers","href":"/computer-use-mcp"},{"title":"Engines and Commerce MCP Servers","href":"/computer-use-engines-mcp"}]}]},{"tab":"Skills","icon":"graduation-cap","groups":[{"group":"Start here","pages":[{"title":"Skills","href":"/agent-skills"}]},{"group":"Skills","pages":[{"title":"iCommerce Agent Operating Guide","href":"/stateset-icommerce-skill"},{"title":"NSR Skill","href":"/stateset-nsr-skill"},{"title":"Sandbox agent operating guide","href":"/stateset-sandbox-skill"},{"title":"Voice Skill","href":"/stateset-voice-skill"},{"title":"Computer Use Skill","href":"/computer-use-skill"},{"title":"Sync Server Skill","href":"/stateset-sync-server-skill"},{"title":"StateSet iCommerce Engine Skills","href":"/stateset-icommerce/stateset-icommerce-skills"}]}]}]}]},"basePath":"","title":"StateSet API Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js"]}