Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The session request body, containing the agents to use in the session and other settings
agentGraphRequest
AgentGraphRequest · object
required
A request for the agents in this session
Show child attributes
namespaceProvider
create_if_not_exists · object
required
Provides a full namespace request to create an ad hoc namespace if the namespace doesn't already exist. Note that this will not update an existing namespace, so for example, there is no guarantee that annotations specified on this request end up on the namespace that this session belongs in.
create_if_not_exists
use_existing
Show child attributes
execution
defer · object
The session's execution is deferred. A deferred execution must be executed manually later
defer
immediate
Show child attributes
budgetSettings
SessionBudgetSettings · object
Budget settings for this session. See SessionBudgetSettings for more information
{"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/create-session","slug":"/api-reference/local/create-session","pageMetadata":{"title":"Create session","description":"Creates a new session in a given namespace","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/local/session","href":"/api-reference/local/create-session","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: \"Creates a new session in a given namespace\"\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":"Create session","description":"Creates a new session in a given namespace","deprecated":false,"version":null,"openapi":"/api_v1.json post /api/v1/local/session","href":"/api-reference/local/create-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["local"],"summary":"Create session","description":"Creates a new session in a given namespace","operationId":"createSession","parameters":[],"requestBody":"7e70eb4e-187f-4e5d-98d0-18ee09abcf44","responses":{"200":"d1f2d4cc-f1e5-4b25-bd78-6b9a972841bd","400":"0c75689a-5980-4f58-8ff5-710cfe285768","403":"64422a94-0ca9-40e3-a868-16f2423f5127"},"deprecated":false,"security":["8ff99579-f467-4e7e-8ee3-3a36dc56085a"],"method":"post","type":"path","servers":[],"path":"/api/v1/local/session","baseUrlOptions":[],"title":"Create session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"The session request body, containing the agents to use in the session and other settings","content":{"application/json":{"schema":{"type":"object","properties":{"agentGraphRequest":{"type":"object","properties":{"agents":{"type":"array","description":"Every agent required for this agent graph","items":{"type":"object","description":"A request for an agent. GraphAgentRequest -> GraphAgent","properties":{"id":{"type":"object","properties":{"name":{"type":"string","description":"The exact name of the agent in the registry","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.name","typeLabel":"string"},"version":{"type":"string","description":"The exact version of the agent in the registry","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.version","typeLabel":"string"},"registrySourceId":{"oneOf":[{"type":"object","title":"linked","description":"The identifier for the registry source that contains this agent","required":["linkedServerId","type"],"properties":{"type":{"type":"string","enum":["linked"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.0.type","typeLabel":"enum\u003cstring>"},"linkedServerId":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.0.linkedServerId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.0","typeLabel":"linked · object"},{"type":"object","title":"local","description":"The identifier for the registry source that contains this agent","required":["type"],"properties":{"type":{"type":"string","enum":["local"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.1","typeLabel":"local · object"},{"type":"object","title":"marketplace","description":"The identifier for the registry source that contains this agent","required":["type"],"properties":{"type":{"type":"string","enum":["marketplace"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId.oneOf.2","typeLabel":"marketplace · object"}],"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id.registrySourceId","typeLabel":"linked · object | local · object | marketplace · object"}},"required":["name","registrySourceId","version"],"title":"RegistryAgentIdentifier","description":"The ID of this agent in the registry","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].id","typeLabel":"RegistryAgentIdentifier · object"},"name":{"type":"string","description":"A given name for this agent in the session/group","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].name","typeLabel":"string"},"provider":{"oneOf":[{"type":"object","title":"linked","description":"The agent will be provided by a linked server","required":["linkedServerName","runtime","type"],"properties":{"type":{"type":"string","enum":["linked"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.0.type","typeLabel":"enum\u003cstring>"},"linkedServerName":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.0.linkedServerName","typeLabel":"string"},"runtime":{"type":"string","enum":["executable","docker","function","prototype"],"title":"RuntimeId","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.0.runtime","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.0","typeLabel":"linked · object"},{"type":"object","title":"local","description":"The agent will be provided by this server","required":["runtime","type"],"properties":{"type":{"type":"string","enum":["local"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.1.type","typeLabel":"enum\u003cstring>"},"runtime":{"type":"string","enum":["executable","docker","function","prototype"],"title":"RuntimeId","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.1.runtime","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider.oneOf.1","typeLabel":"local · object"}],"isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].provider","typeLabel":"linked · object | local · object"},"description":{"type":"string","description":"An optional override for the description of this agent","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].description","typeLabel":"string"},"options":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","title":"blob","required":["type","value"],"properties":{"type":{"type":"string","enum":["blob"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.0","typeLabel":"blob · object"},{"type":"object","title":"list[blob]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[blob]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.1.value.items.[INDEX]","typeLabel":"string"},"title":"ArrayList\u003cString>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.1.value","typeLabel":"string[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.1","typeLabel":"list[blob] · object"},{"type":"object","title":"bool","required":["type","value"],"properties":{"type":{"type":"string","enum":["bool"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"boolean","title":"Boolean","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.2.value","typeLabel":"boolean"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.2","typeLabel":"bool · object"},{"type":"object","title":"i8","required":["type","value"],"properties":{"type":{"type":"string","enum":["i8"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","maximum":127,"minimum":-128,"title":"Byte","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.3.value","typeLabel":"integer"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.3","typeLabel":"i8 · object"},{"type":"object","title":"list[i8]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[i8]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","maximum":127,"minimum":-128,"title":"Byte","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.4.value.items.[INDEX]","typeLabel":"integer"},"title":"ArrayList\u003cByte>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.4.value","typeLabel":"integer[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.4","typeLabel":"list[i8] · object"},{"type":"object","title":"f64","required":["type","value"],"properties":{"type":{"type":"string","enum":["f64"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.5.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"double","title":"Double","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.5.value","typeLabel":"number\u003cdouble>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.5","typeLabel":"f64 · object"},{"type":"object","title":"list[f64]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[f64]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.6.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"number","format":"double","title":"Double","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.6.value.items.[INDEX]","typeLabel":"number\u003cdouble>"},"title":"ArrayList\u003cDouble>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.6.value","typeLabel":"number\u003cdouble>[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.6","typeLabel":"list[f64] · object"},{"type":"object","title":"f32","required":["type","value"],"properties":{"type":{"type":"string","enum":["f32"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.7.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","format":"float","title":"Float","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.7.value","typeLabel":"number\u003cfloat>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.7","typeLabel":"f32 · object"},{"type":"object","title":"list[f32]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[f32]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.8.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"number","format":"float","title":"Float","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.8.value.items.[INDEX]","typeLabel":"number\u003cfloat>"},"title":"ArrayList\u003cFloat>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.8.value","typeLabel":"number\u003cfloat>[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.8","typeLabel":"list[f32] · object"},{"type":"object","title":"i32","required":["type","value"],"properties":{"type":{"type":"string","enum":["i32"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.9.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int32","title":"Int","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.9.value","typeLabel":"integer\u003cint32>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.9","typeLabel":"i32 · object"},{"type":"object","title":"list[i32]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[i32]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.10.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","format":"int32","title":"Int","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.10.value.items.[INDEX]","typeLabel":"integer\u003cint32>"},"title":"ArrayList\u003cInt>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.10.value","typeLabel":"integer\u003cint32>[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.10","typeLabel":"list[i32] · object"},{"type":"object","title":"i64","required":["type","value"],"properties":{"type":{"type":"string","enum":["i64"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.11.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","format":"int64","title":"Long","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.11.value","typeLabel":"integer\u003cint64>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.11","typeLabel":"i64 · object"},{"type":"object","title":"list[i64]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[i64]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.12.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","format":"int64","title":"Long","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.12.value.items.[INDEX]","typeLabel":"integer\u003cint64>"},"title":"ArrayList\u003cLong>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.12.value","typeLabel":"integer\u003cint64>[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.12","typeLabel":"list[i64] · object"},{"type":"object","title":"i16","required":["type","value"],"properties":{"type":{"type":"string","enum":["i16"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.13.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","maximum":32767,"minimum":-32768,"title":"Short","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.13.value","typeLabel":"integer"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.13","typeLabel":"i16 · object"},{"type":"object","title":"list[i16]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[i16]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.14.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","maximum":32767,"minimum":-32768,"title":"Short","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.14.value.items.[INDEX]","typeLabel":"integer"},"title":"ArrayList\u003cShort>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.14.value","typeLabel":"integer[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.14","typeLabel":"list[i16] · object"},{"type":"object","title":"string","required":["type","value"],"properties":{"type":{"type":"string","enum":["string"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.15.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.15.value","typeLabel":"string"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.15","typeLabel":"string · object"},{"type":"object","title":"list[string]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[string]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.16.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.16.value.items.[INDEX]","typeLabel":"string"},"title":"ArrayList\u003cString>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.16.value","typeLabel":"string[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.16","typeLabel":"list[string] · object"},{"type":"object","title":"u8","required":["type","value"],"properties":{"type":{"type":"string","enum":["u8"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.17.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","maximum":255,"minimum":0,"title":"UByte","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.17.value","typeLabel":"integer"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.17","typeLabel":"u8 · object"},{"type":"object","title":"list[u8]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[u8]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.18.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","maximum":255,"minimum":0,"title":"UByte","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.18.value.items.[INDEX]","typeLabel":"integer"},"title":"ArrayList\u003cUByte>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.18.value","typeLabel":"integer[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.18","typeLabel":"list[u8] · object"},{"type":"object","title":"u32","required":["type","value"],"properties":{"type":{"type":"string","enum":["u32"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.19.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","maximum":4294967295,"minimum":0,"title":"UInt","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.19.value","typeLabel":"integer"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.19","typeLabel":"u32 · object"},{"type":"object","title":"list[u32]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[u32]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.20.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","maximum":4294967295,"minimum":0,"title":"UInt","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.20.value.items.[INDEX]","typeLabel":"integer"},"title":"ArrayList\u003cUInt>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.20.value","typeLabel":"integer[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.20","typeLabel":"list[u32] · object"},{"type":"object","title":"u64","required":["type","value"],"properties":{"type":{"type":"string","enum":["u64"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.21.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.21.value","typeLabel":"string"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.21","typeLabel":"u64 · object"},{"type":"object","title":"list[u64]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[u64]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.22.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.22.value.items.[INDEX]","typeLabel":"string"},"title":"ArrayList\u003cString>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.22.value","typeLabel":"string[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.22","typeLabel":"list[u64] · object"},{"type":"object","title":"u16","required":["type","value"],"properties":{"type":{"type":"string","enum":["u16"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.23.type","typeLabel":"enum\u003cstring>"},"value":{"type":"integer","maximum":65535,"minimum":0,"title":"UShort","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.23.value","typeLabel":"integer"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.23","typeLabel":"u16 · object"},{"type":"object","title":"list[u16]","required":["type","value"],"properties":{"type":{"type":"string","enum":["list[u16]"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.24.type","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"integer","maximum":65535,"minimum":0,"title":"UShort","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.24.value.items.[INDEX]","typeLabel":"integer"},"title":"ArrayList\u003cUShort>","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.24.value","typeLabel":"integer[]"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties.oneOf.24","typeLabel":"list[u16] · object"}],"uniqueKey":"agentGraphRequest.agents.items.[INDEX].options.additionalProperties","typeLabel":"blob · object | list[blob] · object | bool · object | i8 · object | list[i8] · object | f64 · object | list[f64] · object | f32 · object | list[f32] · object | i32 · object | list[i32] · object | i64 · object | list[i64] · object | i16 · object | list[i16] · object | string · object | list[string] · object | u8 · object | list[u8] · object | u32 · object | list[u32] · object | u64 · object | list[u64] · object | u16 · object | list[u16] · object"},"description":"The arguments to pass to the agent","title":"LinkedHashMap\u003cString,AgentOptionValue>","uniqueKey":"agentGraphRequest.agents.items.[INDEX].options","typeLabel":"LinkedHashMap\u003cString,AgentOptionValue> · object"},"systemPrompt":{"type":"string","description":"The system prompt/developer text/preamble passed to the agent","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].systemPrompt","typeLabel":"string"},"blocking":{"type":"boolean","description":"All blocking agents in a group must be instantiated before the group can communicate. Non-blocking agents' contributions to groups are optional","title":"Boolean","uniqueKey":"agentGraphRequest.agents.items.[INDEX].blocking","typeLabel":"boolean"},"customToolAccess":{"type":"array","description":"A list of custom tools that this agent can access. The custom tools must be defined in the parent AgentGraphRequest object","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].customToolAccess.items.[INDEX]","typeLabel":"string"},"title":"LinkedHashSet\u003cString>","uniqueItems":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].customToolAccess","typeLabel":"string[]"},"plugins":{"type":"array","description":"Plugins that should be installed on this agent. See GraphAgentPlugin for more information","items":{"type":"object","title":"GraphAgentPlugin","required":["type"],"properties":{"type":{"type":"string","enum":["close_session_tool"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].plugins.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].plugins.items.[INDEX]","typeLabel":"GraphAgentPlugin · object"},"title":"LinkedHashSet\u003cGraphAgentPlugin>","uniqueItems":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].plugins","typeLabel":"GraphAgentPlugin · object[]"},"x402Budgets":{"type":"array","description":"An optional list of resources and an accompanied budget that this agent may spend on services that accept x402 payments","items":{"type":"object","description":"A budget given to an agent for a specific resource","properties":{"priority":{"type":"integer","format":"int32","description":"The priority of this budget. If a x402 service accepts multiple resources and an agent was given a budget for multiple resources, the resource with the highest priority will be used until it is consumed","title":"Int","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].x402Budgets.items.[INDEX].priority","typeLabel":"integer\u003cint32>"},"resource":{"type":"string","description":"The this budget is for","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].x402Budgets.items.[INDEX].resource","typeLabel":"string"},"remainingBudget":{"type":"integer","description":"The remaining budget for this resource in atomic units","title":"ULong","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].x402Budgets.items.[INDEX].remainingBudget","typeLabel":"integer"}},"required":["priority","remainingBudget","resource"],"title":"X402BudgetedResource","uniqueKey":"agentGraphRequest.agents.items.[INDEX].x402Budgets.items.[INDEX]","typeLabel":"X402BudgetedResource · object"},"title":"ArrayList\u003cX402BudgetedResource>","uniqueKey":"agentGraphRequest.agents.items.[INDEX].x402Budgets","typeLabel":"X402BudgetedResource · object[]"},"proxies":{"type":"object","additionalProperties":{"type":"object","properties":{"configurationName":{"type":"string","description":"The name of the LLM proxy configuration","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].proxies.additionalProperties.configurationName","typeLabel":"string"},"modelName":{"type":"string","description":"The name of the model","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].proxies.additionalProperties.modelName","typeLabel":"string"}},"required":["configurationName","modelName"],"title":"GraphAgentProxyRequest","uniqueKey":"agentGraphRequest.agents.items.[INDEX].proxies.additionalProperties","typeLabel":"GraphAgentProxyRequest · object"},"description":"A map where the key is the name of the proxy request and the value is the configuration and model that should be selected.","title":"LinkedHashMap\u003cString,GraphAgentProxyRequest>","uniqueKey":"agentGraphRequest.agents.items.[INDEX].proxies","typeLabel":"LinkedHashMap\u003cString,GraphAgentProxyRequest> · object"},"budgetSettings":{"type":"object","properties":{"budget":{"type":"integer","description":"The budget for this specific agent. The value is specified in micro cents. $1.00 is 100000000 and $0.01 is 1000000.","title":"AgentBudgetUnit","uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.budget","typeLabel":"integer"},"claimTypeCosts":{"type":"object","additionalProperties":{"type":"integer","title":"AgentBudgetUnit","uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.claimTypeCosts.additionalProperties","typeLabel":"integer"},"description":"A map where each key is a claim type name and the value the cost for that claim. Claims that do not have default values set must have their values set in this map or else they will not contribute to the budget.","title":"LinkedHashMap\u003cString,AgentBudgetUnit>","uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.claimTypeCosts","typeLabel":"LinkedHashMap\u003cString,AgentBudgetUnit> · object"},"exhaustionBehavior":{"oneOf":[{"type":"object","title":"consume_session","description":"Once's the agent's budget is exhausted, it will consume the session's budget. If the session's budget is also exhausted, the session's exhaustion behavior will be applied. If a claim is made that cannot be fully fulfilled by the agent's budget, the remainder will be taken from the session's budget.","required":["type"],"properties":{"type":{"type":"string","enum":["consume_session"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.0","typeLabel":"consume_session · object"},{"type":"object","title":"kill","description":"Once the agent's budget is less than the specified minimum amount, the agent will be killed. The higher the minimum is the lower the chance of overclaiming. This behavior will stop the agent claiming from the session's budget","required":["force","minimum","type"],"properties":{"type":{"type":"string","enum":["kill"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.1.type","typeLabel":"enum\u003cstring>"},"minimum":{"type":"integer","description":"The minimum value, specified in micro cents. $1.00 is 100000000 and $0.01 is 1000000.","title":"AgentBudgetUnit","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.1.minimum","typeLabel":"integer"},"force":{"type":"boolean","description":"If this is true, the agent will be killed immediately. If this is false, the agent will only be killed if the claim requests for automatic closing.","title":"Boolean","isRequired":true,"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.1.force","typeLabel":"boolean"},"forceDelay":{"type":"string","description":"If force killing is enabled, it will be delayed by this amount before the agent is killed. If this delay is too low the agent may be killed before it handles to response to a claim","title":"Duration","uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.1.forceDelay","typeLabel":"string"}},"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior.oneOf.1","typeLabel":"kill · object"}],"uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings.exhaustionBehavior","typeLabel":"consume_session · object | kill · object"}},"title":"GraphAgentBudgetSettings","description":"Budget settings for this agent. By default the agent has no budget of its own, and can only claim from the sessions budget.","uniqueKey":"agentGraphRequest.agents.items.[INDEX].budgetSettings","typeLabel":"GraphAgentBudgetSettings · object"},"annotations":{"type":"object","additionalProperties":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.agents.items.[INDEX].annotations.additionalProperties","typeLabel":"string"},"title":"LinkedHashMap\u003cString,String>","uniqueKey":"agentGraphRequest.agents.items.[INDEX].annotations","typeLabel":"LinkedHashMap\u003cString,String> · object"}},"required":["id","name","provider"],"title":"GraphAgentRequest","uniqueKey":"agentGraphRequest.agents.items.[INDEX]","typeLabel":"GraphAgentRequest · object"},"title":"ArrayList\u003cGraphAgentRequest>","isRequired":true,"uniqueKey":"agentGraphRequest.agents","typeLabel":"GraphAgentRequest · object[]"},"groups":{"type":"array","description":"A set, containing sets that define the agent groups by name","items":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.groups.items.[INDEX].items.[INDEX]","typeLabel":"string"},"title":"LinkedHashSet\u003cString>","uniqueItems":true,"uniqueKey":"agentGraphRequest.groups.items.[INDEX]","typeLabel":"string[]"},"title":"LinkedHashSet\u003cLinkedHashSet\u003cString>>","uniqueItems":true,"uniqueKey":"agentGraphRequest.groups","typeLabel":"string[][]"},"customTools":{"type":"object","additionalProperties":{"type":"object","properties":{"transport":{"type":"object","title":"GraphAgentToolTransport","required":["type","url"],"properties":{"type":{"type":"string","enum":["http"],"title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.customTools.additionalProperties.transport.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.customTools.additionalProperties.transport.url","typeLabel":"string"},"signatureHeader":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.transport.signatureHeader","typeLabel":"string"}},"isRequired":true,"uniqueKey":"agentGraphRequest.customTools.additionalProperties.transport","typeLabel":"GraphAgentToolTransport · object"},"inputSchema":{"type":"object","properties":{"type":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.type","typeLabel":"string"},"$schema":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.$schema","typeLabel":"string"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{},"title":"JsonElement","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.properties.additionalProperties","typeLabel":"JsonElement · object"},"title":"JsonObject\u003cString,JsonElement>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.properties","typeLabel":"JsonObject\u003cString,JsonElement> · object"},"required":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.required.items.[INDEX]","typeLabel":"string"},"title":"ArrayList\u003cString>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.required","typeLabel":"string[]"},"$defs":{"type":"object","additionalProperties":{"type":"object","properties":{},"title":"JsonElement","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.$defs.additionalProperties","typeLabel":"JsonElement · object"},"title":"JsonObject\u003cString,JsonElement>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema.$defs","typeLabel":"JsonObject\u003cString,JsonElement> · object"}},"required":["type"],"title":"ToolSchema","uniqueKey":"agentGraphRequest.customTools.additionalProperties.inputSchema","typeLabel":"ToolSchema · object"},"outputSchema":{"type":"object","properties":{"type":{"type":"string","title":"String","isRequired":true,"uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.type","typeLabel":"string"},"$schema":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.$schema","typeLabel":"string"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{},"title":"JsonElement","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.properties.additionalProperties","typeLabel":"JsonElement · object"},"title":"JsonObject\u003cString,JsonElement>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.properties","typeLabel":"JsonObject\u003cString,JsonElement> · object"},"required":{"type":"array","items":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.required.items.[INDEX]","typeLabel":"string"},"title":"ArrayList\u003cString>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.required","typeLabel":"string[]"},"$defs":{"type":"object","additionalProperties":{"type":"object","properties":{},"title":"JsonElement","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.$defs.additionalProperties","typeLabel":"JsonElement · object"},"title":"JsonObject\u003cString,JsonElement>","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema.$defs","typeLabel":"JsonObject\u003cString,JsonElement> · object"}},"required":["type"],"title":"ToolSchema","uniqueKey":"agentGraphRequest.customTools.additionalProperties.outputSchema","typeLabel":"ToolSchema · object"},"description":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.description","typeLabel":"string"},"title":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.title","typeLabel":"string"},"annotations":{"type":"object","properties":{"title":{"type":"string","title":"String","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations.title","typeLabel":"string"},"readOnlyHint":{"type":"boolean","title":"Boolean","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations.readOnlyHint","typeLabel":"boolean"},"destructiveHint":{"type":"boolean","title":"Boolean","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations.destructiveHint","typeLabel":"boolean"},"idempotentHint":{"type":"boolean","title":"Boolean","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations.idempotentHint","typeLabel":"boolean"},"openWorldHint":{"type":"boolean","title":"Boolean","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations.openWorldHint","typeLabel":"boolean"}},"title":"ToolAnnotations","uniqueKey":"agentGraphRequest.customTools.additionalProperties.annotations","typeLabel":"ToolAnnotations · object"}},"required":["transport"],"title":"GraphAgentTool","uniqueKey":"agentGraphRequest.customTools.additionalProperties","typeLabel":"GraphAgentTool · object"},"description":"A map of custom tools to provide to the agents in this graph","title":"LinkedHashMap\u003cString,GraphAgentTool>","uniqueKey":"agentGraphRequest.customTools","typeLabel":"LinkedHashMap\u003cString,GraphAgentTool> · object"}},"required":["agents"],"title":"AgentGraphRequest","description":"A request for the agents in this session","isRequired":true,"uniqueKey":"agentGraphRequest","typeLabel":"AgentGraphRequest · object"},"namespaceProvider":{"oneOf":[{"type":"object","title":"create_if_not_exists","description":"\n Provides a full namespace request to create an ad hoc namespace if the namespace doesn't already exist. Note\n that this will not update an existing namespace, so for example, there is no guarantee that annotations \n specified on this request end up on the namespace that this session belongs in.\n ","required":["namespaceRequest","type"],"properties":{"type":{"type":"string","enum":["create_if_not_exists"],"title":"String","isRequired":true,"uniqueKey":"namespaceProvider.oneOf.0.type","typeLabel":"enum\u003cstring>"},"namespaceRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of this namespace","title":"String","isRequired":true,"uniqueKey":"namespaceProvider.oneOf.0.namespaceRequest.name","typeLabel":"string"},"deleteOnLastSessionExit":{"type":"boolean","description":"\n If this is true the namespace will be deleted when the last session in this namespace closes. Note that this\n does not guarantee that the namespace will never be empty, because namespaces can be created without sessions\n ","title":"Boolean","uniqueKey":"namespaceProvider.oneOf.0.namespaceRequest.deleteOnLastSessionExit","typeLabel":"boolean"},"annotations":{"type":"object","additionalProperties":{"type":"string","title":"String","uniqueKey":"namespaceProvider.oneOf.0.namespaceRequest.annotations.additionalProperties","typeLabel":"string"},"title":"LinkedHashMap\u003cString,String>","uniqueKey":"namespaceProvider.oneOf.0.namespaceRequest.annotations","typeLabel":"LinkedHashMap\u003cString,String> · object"}},"required":["name"],"title":"SessionNamespaceRequest","isRequired":true,"uniqueKey":"namespaceProvider.oneOf.0.namespaceRequest","typeLabel":"SessionNamespaceRequest · object"}},"isRequired":true,"uniqueKey":"namespaceProvider.oneOf.0","typeLabel":"create_if_not_exists · object"},{"type":"object","title":"use_existing","description":"Indicates that the session request should use an existing namespace","required":["name","type"],"properties":{"type":{"type":"string","enum":["use_existing"],"title":"String","isRequired":true,"uniqueKey":"namespaceProvider.oneOf.1.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","title":"String","isRequired":true,"uniqueKey":"namespaceProvider.oneOf.1.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"namespaceProvider.oneOf.1","typeLabel":"use_existing · object"}],"isRequired":true,"uniqueKey":"namespaceProvider","typeLabel":"create_if_not_exists · object | use_existing · object"},"execution":{"oneOf":[{"type":"object","title":"defer","description":"The session's execution is deferred. A deferred execution must be executed manually later","required":["mode"],"properties":{"mode":{"type":"string","enum":["defer"],"title":"String","isRequired":true,"uniqueKey":"execution.oneOf.0.mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"execution.oneOf.0","typeLabel":"defer · object"},{"type":"object","title":"immediate","description":"The session should be executed immediately with the specified runtime settings","required":["mode"],"properties":{"mode":{"type":"string","enum":["immediate"],"title":"String","isRequired":true,"uniqueKey":"execution.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"runtimeSettings":{"type":"object","properties":{"ttl":{"type":"integer","format":"int64","description":"If specified, the session will never live longer than this many milliseconds.","title":"Long","uniqueKey":"execution.oneOf.1.runtimeSettings.ttl","typeLabel":"integer\u003cint64>"},"extendedEndReport":{"type":"boolean","description":"If specified, the end report generated for this session will be extended, including threads and messages","title":"Boolean","uniqueKey":"execution.oneOf.1.runtimeSettings.extendedEndReport","typeLabel":"boolean"},"persistenceMode":{"oneOf":[{"type":"object","title":"hold_after_exit","description":"Session will exist for at least the specified time (in milliseconds) after the session exits. This time does not include the run time of the session.","required":["duration","mode"],"properties":{"mode":{"type":"string","enum":["hold_after_exit"],"title":"String","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"duration":{"type":"integer","format":"int64","title":"Long","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.0.duration","typeLabel":"integer\u003cint64>"}},"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.0","typeLabel":"hold_after_exit · object"},{"type":"object","title":"minimum_time","description":"Session will exist for at least the specified time (in milliseconds). This time includes the run time of the session.","required":["mode","time"],"properties":{"mode":{"type":"string","enum":["minimum_time"],"title":"String","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.1.mode","typeLabel":"enum\u003cstring>"},"time":{"type":"integer","format":"int64","title":"Long","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.1.time","typeLabel":"integer\u003cint64>"}},"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.1","typeLabel":"minimum_time · object"},{"type":"object","title":"none","description":"No persistence","required":["mode"],"properties":{"mode":{"type":"string","enum":["none"],"title":"String","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.2.mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode.oneOf.2","typeLabel":"none · object"}],"uniqueKey":"execution.oneOf.1.runtimeSettings.persistenceMode","typeLabel":"hold_after_exit · object | minimum_time · object | none · object"},"webhooks":{"type":"object","properties":{"sessionEnd":{"type":"object","description":"The webhook that is called when this session ends. The model sent is a SessionEndState","properties":{"url":{"type":"string","title":"String","isRequired":true,"uniqueKey":"execution.oneOf.1.runtimeSettings.webhooks.sessionEnd.url","typeLabel":"string"}},"required":["url"],"title":"SessionEndWebhook","uniqueKey":"execution.oneOf.1.runtimeSettings.webhooks.sessionEnd","typeLabel":"SessionEndWebhook · object"}},"title":"SessionWebhooks","description":"Webhooks executed for this session","uniqueKey":"execution.oneOf.1.runtimeSettings.webhooks","typeLabel":"SessionWebhooks · object"}},"title":"SessionRuntimeSettings","uniqueKey":"execution.oneOf.1.runtimeSettings","typeLabel":"SessionRuntimeSettings · object"}},"uniqueKey":"execution.oneOf.1","typeLabel":"immediate · object"}],"uniqueKey":"execution","typeLabel":"defer · object | immediate · object"},"budgetSettings":{"type":"object","description":"Budget settings for this session. See SessionBudgetSettings for more information","properties":{"budget":{"type":"integer","description":"\n This budget is shared across all agents in the session and can be used by any agent configured to consume the shared budget.\n \n The value is specified in micro cents. $1.00 is 100000000 and $0.01 is 1000000.\") \n ","title":"AgentBudgetUnit","uniqueKey":"budgetSettings.budget","typeLabel":"integer"},"exhaustionBehavior":{"oneOf":[{"type":"object","title":"ignore","description":"The exhaustion of the session's budget will be ignored. This has a high chance of overclaiming.","required":["type"],"properties":{"type":{"type":"string","enum":["ignore"],"title":"String","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.0","typeLabel":"ignore · object"},{"type":"object","title":"kill_agent","description":"Once the session budget drops below the specified minimum, agents that claim for it will be killed. The higher the minimum is the lower the chance of overclaiming.","required":["force","minimum","type"],"properties":{"type":{"type":"string","enum":["kill_agent"],"title":"String","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.1.type","typeLabel":"enum\u003cstring>"},"minimum":{"type":"integer","description":"The minimum value, specified in micro cents. $1.00 is 100000000 and $0.01 is 1000000.","title":"AgentBudgetUnit","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.1.minimum","typeLabel":"integer"},"force":{"type":"boolean","description":"If this is true, when an agent claims from the session budget that is below the minimum, the agent will be killed immediately. If this is false, the agent will only be killed if the agent requests for automatic closing.","title":"Boolean","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.1.force","typeLabel":"boolean"},"forceDelay":{"type":"string","description":"If force killing is enabled, it will be delayed by this amount before the agent is killed. If this delay is too low the agent may be killed before it handles to response to a claim","title":"Duration","uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.1.forceDelay","typeLabel":"string"}},"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.1","typeLabel":"kill_agent · object"},{"type":"object","title":"kill_session","description":"Once the session budget drops below the specified minimum, agents that claim for it will trigger the session to be killed. The higher the minimum is the lower the chance of overclaiming.","required":["minimum","type"],"properties":{"type":{"type":"string","enum":["kill_session"],"title":"String","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimum":{"type":"integer","description":"The minimum value, specified in micro cents. $1.00 is 100000000 and $0.01 is 1000000.","title":"AgentBudgetUnit","isRequired":true,"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.2.minimum","typeLabel":"integer"},"delay":{"type":"string","description":"The delay before the session is killed. If this delay is too low, the agent whose claim triggered this may be killed before it receives the response to that claim","title":"Duration","uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.2.delay","typeLabel":"string"}},"uniqueKey":"budgetSettings.exhaustionBehavior.oneOf.2","typeLabel":"kill_session · object"}],"uniqueKey":"budgetSettings.exhaustionBehavior","typeLabel":"ignore · object | kill_agent · object | kill_session · object"}},"title":"SessionBudgetSettings","uniqueKey":"budgetSettings","typeLabel":"SessionBudgetSettings · object"},"annotations":{"type":"object","additionalProperties":{"type":"string","title":"String","uniqueKey":"annotations.additionalProperties","typeLabel":"string"},"title":"LinkedHashMap\u003cString,String>","uniqueKey":"annotations","typeLabel":"LinkedHashMap\u003cString,String> · object"}},"required":["agentGraphRequest","namespaceProvider"],"title":"SessionRequest","uniqueKey":"","typeLabel":"SessionRequest · object"},"examples":{"Example":{"title":"Example","value":{"agentGraphRequest":{"agents":[{"id":{"name":"\u003cstring>","version":"\u003cstring>","registrySourceId":{"type":"linked","linkedServerId":"\u003cstring>"}},"name":"\u003cstring>","provider":{"type":"linked","linkedServerName":"\u003cstring>"},"description":"\u003cstring>","options":{},"systemPrompt":"\u003cstring>","blocking":true,"customToolAccess":["\u003cstring>"],"plugins":[{"type":"close_session_tool"}],"x402Budgets":[{"priority":123,"resource":"\u003cstring>","remainingBudget":123}],"proxies":{},"budgetSettings":{"budget":123,"claimTypeCosts":{},"exhaustionBehavior":{"type":"consume_session"}},"annotations":{}}],"groups":[["\u003cstring>"]],"customTools":{}},"namespaceProvider":{"type":"create_if_not_exists","namespaceRequest":{"name":"\u003cstring>","deleteOnLastSessionExit":true,"annotations":{}}},"execution":{"mode":"defer"},"budgetSettings":{"budget":123,"exhaustionBehavior":{"type":"ignore"}},"annotations":{}}}},"exampleType":"generated"}},"required":false,"exampleType":"generated"},"responses":{"d1f2d4cc-f1e5-4b25-bd78-6b9a972841bd":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"namespace":{"type":"string","description":"The namespace that this session belongs in","title":"String","isRequired":true,"uniqueKey":"namespace","typeLabel":"string"},"sessionId":{"type":"string","description":"The unique identifier for the session","title":"String","isRequired":true,"uniqueKey":"sessionId","typeLabel":"string"}},"required":["namespace","sessionId"],"title":"SessionIdentifier","uniqueKey":"","typeLabel":"SessionIdentifier · object"},"examples":{"Example":{"title":"Example","value":{"namespace":"\u003cstring>","sessionId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0c75689a-5980-4f58-8ff5-710cfe285768":{"description":"The agent graph is invalid and could not be processed","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"},"64422a94-0ca9-40e3-a868-16f2423f5127":{"description":"Invalid application ID or privacy key","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":{"8ff99579-f467-4e7e-8ee3-3a36dc56085a":{"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":"Create session - CoralOS Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-12T21:26:06.820Z","originalFileLocation":"api-reference/local/create-session.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=\"Creates a new session in a given namespace\">\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=\"Create session - CoralOS Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new session in a given namespace\">\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/create-session\">\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=Create+session\u0026amp;description=Creates+a+new+session+in+a+given+namespace\u0026amp;theme=6b755d498e9fe788c04e59c9\u0026amp;signature=c62f7cad17f434824d87a161e54e5ef9cb76d8ef0fef9ebbd328eafc530a8176\">\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=\"Create session - CoralOS Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new session in a given namespace\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://23turtles.mintlify.site/_mintlify/api/og/v2?division=Session\u0026amp;title=Create+session\u0026amp;description=Creates+a+new+session+in+a+given+namespace\u0026amp;theme=6b755d498e9fe788c04e59c9\u0026amp;signature=c62f7cad17f434824d87a161e54e5ef9cb76d8ef0fef9ebbd328eafc530a8176\">\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/create-session\">\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/create-session.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/create-session#webpage\",\"url\":\"https://docs.coralos.ai/api-reference/local/create-session\",\"name\":\"Create session\",\"description\":\"Creates a new session in a given namespace\",\"dateModified\":\"2026-10-12T21:26:06.820Z\",\"isPartOf\":{\"@id\":\"https://docs.coralos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.coralos.ai/api-reference/local/create-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.coralos.ai/api-reference/local/create-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CoralOS Docs\",\"item\":\"https://docs.coralos.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create session\",\"item\":\"https://docs.coralos.ai/api-reference/local/create-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.coralos.ai/api-reference/local/create-session#apireference\",\"headline\":\"Create session\",\"name\":\"Create session\",\"description\":\"Creates a new session in a given namespace\",\"url\":\"https://docs.coralos.ai/api-reference/local/create-session\",\"mainEntityOfPage\":{\"@id\":\"https://docs.coralos.ai/api-reference/local/create-session#webpage\"},\"dateModified\":\"2026-10-12T21:26:06.820Z\",\"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/create-session.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","description":"Executes a session was created with deferred execution","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","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","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":"Create session - 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"]}