Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
namespace
string
required
The namespace of the session
sessionId
string
required
The sessionId of the session
Response
Success
The base state of a running session, without agent or threads
id
string
required
The unique identifier for this session
timestamp
string
required
The timestamp of when this state was generated
namespace
string
required
The namespace that this session resides in
status
closing · object
required
The session is closing and will soon be removed from memory. The closing status can only be observed when the session has persistence configure in SessionRuntimeSettings. Note that there is no closed state for sessions, as closed sessions are deleted from memory
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"CoralOS Docs","colors":{"primary":"#FF5C00","light":"#FF5C00","dark":"#FF5C00"},"logo":{"light":"https://mintcdn.com/23turtles/oTFiGOCfrdlQvBzb/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=oTFiGOCfrdlQvBzb\u0026q=85\u0026s=5b5d5cb78108fa7407b7358b6f31cf03","dark":"https://mintcdn.com/23turtles/oTFiGOCfrdlQvBzb/images/logo/light.svg?fit=max\u0026auto=format\u0026n=oTFiGOCfrdlQvBzb\u0026q=85\u0026s=c4655e3127c784f1c566b1505fc1c388"},"favicon":"https://mintcdn.com/23turtles/oTFiGOCfrdlQvBzb/images/favicon.png?fit=max\u0026auto=format\u0026n=oTFiGOCfrdlQvBzb\u0026q=85\u0026s=434ae90a5c8d39da5364b4bfddab07be","api":{"playground":{"display":"simple"}},"background":{"color":{"dark":"#000"}},"navbar":{"links":[{"href":"mailto:hello@coralos.ai","label":"Support"}],"primary":{"type":"button","label":"Discord","href":"https://discord.gg/3BfS7Ccwcw"}},"footer":{"socials":{"x":"https://x.com/Coral_Protocol","github":"https://github.com/Coral-Protocol","linkedin":"https://www.linkedin.com/company/coralprotocol"}},"icons":{"library":"lucide"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"23turtles","hasAudioNarration":false,"actualSubdomain":"23turtles","customDomains":["docs.coralos.ai"],"gitSource":{"type":"github","owner":"coral-protocol","repo":"docs","deployBranch":"Coral-Documentation","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6acd638914a33e86de90af73","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Guides","count":63},{"language":"default","tag":"Reference","count":33},{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Agent configuration","count":18},{"language":"default","tag":"tables","count":18},{"language":"default","tag":"[options]","count":13},{"language":"default","tag":"Server configuration","count":11},{"language":"default","tag":"Local","count":11},{"language":"default","tag":"Concepts","count":8},{"language":"default","tag":"Namespace","count":6}]},"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/local/get-base-session-state","slug":"/api-reference/local/get-base-session-state","pageMetadata":{"title":"Get base session state","description":"Returns a session's state","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/session/{namespace}/{sessionId}","href":"/api-reference/local/get-base-session-state","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a session’s state\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get base session state","description":"Returns a session's state","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/session/{namespace}/{sessionId}","href":"/api-reference/local/get-base-session-state","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["local"],"summary":"Get base session state","description":"Returns a session's state","operationId":"getSessionState","parameters":["18eeefa4-966a-4ac4-9630-50b40ca46d16","90a52f29-cd42-43d4-9ade-49813d7363fc"],"responses":{"200":"09a10277-adaa-4281-8a9c-5a461b3dcf2d","404":"75531ff8-f08c-4ba2-b907-66c037390ee2"},"deprecated":false,"security":["6694c00f-e33d-402b-b164-6854a9ef3b93"],"method":"get","type":"path","servers":[],"path":"/api/v1/local/session/{namespace}/{sessionId}","baseUrlOptions":[],"title":"Get base session state","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"18eeefa4-966a-4ac4-9630-50b40ca46d16":{"name":"namespace","in":"path","description":"The namespace of the session","required":true,"deprecated":false,"explode":false,"schema":{"type":"string","title":"String","isRequired":true,"description":"The namespace of the session","uniqueKey":"","typeLabel":"string"}},"90a52f29-cd42-43d4-9ade-49813d7363fc":{"name":"sessionId","in":"path","description":"The sessionId of the session","required":true,"deprecated":false,"explode":false,"schema":{"type":"string","title":"String","isRequired":true,"description":"The sessionId of the session","uniqueKey":"","typeLabel":"string"}}},"responses":{"09a10277-adaa-4281-8a9c-5a461b3dcf2d":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"type":"object","description":"The base state of a running session, without agent or threads","properties":{"id":{"type":"string","description":"The unique identifier for this session","title":"String","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"string","description":"The timestamp of when this state was generated","title":"UTC timestamp ISO-8601","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"namespace":{"type":"string","description":"The namespace that this session resides in","title":"String","isRequired":true,"uniqueKey":"namespace","typeLabel":"string"},"status":{"oneOf":[{"type":"object","title":"closing","description":"\n The session is closing and will soon be removed from memory. The closing status can only be observed when \n the session has persistence configure in SessionRuntimeSettings. Note that there is no closed state for \n sessions, as closed sessions are deleted from memory\n ","required":["closingTime","executionTime","type"],"properties":{"type":{"type":"string","enum":["closing"],"title":"String","isRequired":true,"uniqueKey":"status.oneOf.0.type","typeLabel":"enum\u003cstring>"},"executionTime":{"type":"string","title":"UTC timestamp ISO-8601","isRequired":true,"uniqueKey":"status.oneOf.0.executionTime","typeLabel":"string"},"closingTime":{"type":"string","title":"UTC timestamp ISO-8601","isRequired":true,"uniqueKey":"status.oneOf.0.closingTime","typeLabel":"string"}},"isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"closing · object"},{"type":"object","title":"pending_execution","description":"This session status is only achieved when creating sessions with deferred execution","required":["type"],"properties":{"type":{"type":"string","enum":["pending_execution"],"title":"String","isRequired":true,"uniqueKey":"status.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"pending_execution · object"},{"type":"object","title":"executed","description":"\n The session launched it's agents and is currently running. The session's status will remain as running until:\n \n 1. All the agents in the session exit, or\n 2. The session's TTL expires, or\n 3. Manual exit \n ","required":["executionTime","type"],"properties":{"type":{"type":"string","enum":["executed"],"title":"String","isRequired":true,"uniqueKey":"status.oneOf.2.type","typeLabel":"enum\u003cstring>"},"executionTime":{"type":"string","title":"UTC timestamp ISO-8601","isRequired":true,"uniqueKey":"status.oneOf.2.executionTime","typeLabel":"string"}},"isRequired":true,"uniqueKey":"status.oneOf.2","typeLabel":"executed · object"}],"isRequired":true,"uniqueKey":"status","typeLabel":"closing · object | pending_execution · object | executed · object"},"annotations":{"type":"object","additionalProperties":{"type":"string","title":"String","uniqueKey":"annotations.additionalProperties","typeLabel":"string"},"title":"LinkedHashMap\u003cString,String>","isRequired":true,"uniqueKey":"annotations","typeLabel":"LinkedHashMap\u003cString,String> · object"}},"required":["annotations","id","namespace","status","timestamp"],"title":"SessionStateBase","uniqueKey":"","typeLabel":"SessionStateBase · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","timestamp":"\u003cstring>","namespace":"\u003cstring>","status":{"type":"closing","executionTime":"\u003cstring>","closingTime":"\u003cstring>"},"annotations":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"75531ff8-f08c-4ba2-b907-66c037390ee2":{"description":"Either namespace or session ID is invalid","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","title":"String","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"title":"RouteException","uniqueKey":"","typeLabel":"RouteException · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6694c00f-e33d-402b-b164-6854a9ef3b93":{"token":{"type":"http","scheme":"bearer","bearerFormat":"Configured token","scopes":[],"schemeName":"token"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Configured token","scopes":[],"schemeName":"token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"token","name":"Authorization"}],"title":"token"}]},"originalFileLocation":"api_v1.json"},"subdomain":"23turtles","siteName":"CoralOS Docs","title":"Get base session state - CoralOS Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-12T21:26:06.859Z","originalFileLocation":"api-reference/local/get-base-session-state.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a session\u0026#x27;s state\">\u003cmeta data-mint-head name=\"application-name\" content=\"CoralOS Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_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/23turtles/dcF7A9CTIYU_ijKF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get base session state - CoralOS Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a session\u0026#x27;s state\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CoralOS Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.coralos.ai/api-reference/local/get-base-session-state\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://23turtles.mintlify.site/_mintlify/api/og/v2?division=Session\u0026amp;title=Get+base+session+state\u0026amp;description=Returns+a+session%27s+state\u0026amp;theme=6b755d498e9fe788c04e59c9\u0026amp;signature=e70f366e829aacf9b543d4cd46c0a8fe5c7ba9c8b888e9e8a3c835807fe935e0\">\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=\"Get base session state - CoralOS Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a session\u0026#x27;s state\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://23turtles.mintlify.site/_mintlify/api/og/v2?division=Session\u0026amp;title=Get+base+session+state\u0026amp;description=Returns+a+session%27s+state\u0026amp;theme=6b755d498e9fe788c04e59c9\u0026amp;signature=e70f366e829aacf9b543d4cd46c0a8fe5c7ba9c8b888e9e8a3c835807fe935e0\">\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/23turtles/dcF7A9CTIYU_ijKF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CoralOS Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5C00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.coralos.ai/api-reference/local/get-base-session-state\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/local/get-base-session-state.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.coralos.ai/#organization\",\"name\":\"CoralOS Docs\",\"url\":\"https://docs.coralos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/23turtles/oTFiGOCfrdlQvBzb/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=oTFiGOCfrdlQvBzb\u0026q=85\u0026s=5b5d5cb78108fa7407b7358b6f31cf03\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.coralos.ai#website\",\"name\":\"CoralOS Docs\",\"url\":\"https://docs.coralos.ai\",\"publisher\":{\"@id\":\"https://docs.coralos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state#webpage\",\"url\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state\",\"name\":\"Get base session state\",\"description\":\"Returns a session's state\",\"dateModified\":\"2026-10-12T21:26:06.859Z\",\"isPartOf\":{\"@id\":\"https://docs.coralos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Local\",\"item\":\"https://docs.coralos.ai/api-reference/local/create-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Session\",\"item\":\"https://docs.coralos.ai/api-reference/local/create-session\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get base session state\",\"item\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state#apireference\",\"headline\":\"Get base session state\",\"name\":\"Get base session state\",\"description\":\"Returns a session's state\",\"url\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coralos.ai/api-reference/local/get-base-session-state#webpage\"},\"dateModified\":\"2026-10-12T21:26:06.859Z\",\"publisher\":{\"@id\":\"https://docs.coralos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.coralos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CoralOS Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CoralOS Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/local/get-base-session-state.md","siteName":"CoralOS Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/welcome"}]},{"tab":"API Reference","pages":[{"group":"Local","icon":"bot","pages":[{"group":"Session","expanded":true,"pages":[{"title":"Create session","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/local/session","href":"/api-reference/local/create-session"},{"title":"Executes a session","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/local/session/{namespace}/{sessionId}","href":"/api-reference/local/executes-a-session"},{"title":"Close an active session","description":"Closes an active session, cancelling all running agents","deprecated":false,"version":null,"openapi":"/api_v1.json delete /api/v1/local/session/{namespace}/{sessionId}","href":"/api-reference/local/close-an-active-session"},{"title":"Get base session state","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/session/{namespace}/{sessionId}","href":"/api-reference/local/get-base-session-state"},{"title":"Get extended session state","description":"Returns a session's extended state","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/session/{namespace}/{sessionId}/extended","href":"/api-reference/local/get-extended-session-state"}]},{"group":"Namespace","expanded":true,"pages":[{"title":"Create namespace","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/local/namespace","href":"/api-reference/local/create-namespace"},{"title":"Delete a namespace","deprecated":false,"version":null,"openapi":"/api_v1.json delete /api/v1/local/namespace/{namespace}","href":"/api-reference/local/delete-a-namespace"},{"title":"List base namespace states","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/namespace","href":"/api-reference/local/list-base-namespace-states"},{"title":"List base session states","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/namespace/{namespace}","href":"/api-reference/local/list-base-session-states"},{"title":"List extended session states","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/namespace/{namespace}/extended","href":"/api-reference/local/list-extended-session-states"},{"title":"List extended namespace states","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/local/namespace/extended","href":"/api-reference/local/list-extended-namespace-states"}]}]},{"group":"Registry","icon":"library","pages":[{"title":"Get registry agents","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/registry","href":"/api-reference/registry/get-registry-agents"},{"title":"Inspect local registry agent","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/registry/local/{agentName}/{agentVersion}","href":"/api-reference/registry/inspect-local-registry-agent"},{"title":"Inspect marketplace registry agent","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/registry/marketplace/{agentName}/{agentVersion}","href":"/api-reference/registry/inspect-marketplace-registry-agent"},{"title":"Inspect linked server registry agent","deprecated":false,"version":null,"openapi":"/api_v1.json get /api/v1/registry/linked/{linkedServerName}/{agentName}/{agentVersion}","href":"/api-reference/registry/inspect-linked-server-registry-agent"}]},{"group":"Puppet","icon":"ghost","pages":[{"title":"Create thread","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/puppet/{namespace}/{sessionId}/{agentName}/thread","href":"/api-reference/puppet/create-thread"},{"title":"Close thread","deprecated":false,"version":null,"openapi":"/api_v1.json delete /api/v1/puppet/{namespace}/{sessionId}/{agentName}/thread","href":"/api-reference/puppet/close-thread"},{"title":"Add thread participant","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/puppet/{namespace}/{sessionId}/{agentName}/thread/participant","href":"/api-reference/puppet/add-thread-participant"},{"title":"Remove thread participant","deprecated":false,"version":null,"openapi":"/api_v1.json delete /api/v1/puppet/{namespace}/{sessionId}/{agentName}/thread/participant","href":"/api-reference/puppet/remove-thread-participant"},{"title":"Send message","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/puppet/{namespace}/{sessionId}/{agentName}/thread/message","href":"/api-reference/puppet/send-message"},{"title":"End agent runtime","deprecated":false,"version":null,"openapi":"/api_v1.json delete /api/v1/puppet/{namespace}/{sessionId}/{agentName}","href":"/api-reference/puppet/end-agent-runtime"}]},{"group":"Agent RPC","icon":"key-round","pages":[{"title":"Submit an agent claim","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/agent-rpc/claim","href":"/api-reference/agent-rpc/submit-an-agent-claim"}]},{"group":"Models","pages":[{"title":null,"href":"/api-reference/models/SessionRequest"},{"title":null,"href":"/api-reference/models/AgentGraphRequest"},{"title":null,"href":"/api-reference/models/GraphAgentRequest"},{"title":null,"href":"/api-reference/models/GraphAgentTool"},{"title":null,"href":"/api-reference/models/SessionRuntimeSettings"}]}]}]},"basePath":"","title":"Get base session state - CoralOS Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}