curl --request POST \ --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/" \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "prompt": "New version prompt", "description": "Version description" }'
{ "id": "789e1234-e89b-12d3-a456-426614174002", "version_name": "version 2", "description": "Updated version with new features", "input_definitions": [ { "key": "input_text", "description": "Text to process", "data_type": "text/plain" } ], "engine_config": { "model": "gpt-4", "temperature": "0.5" }, "created_at": "2024-01-16T14:20:00Z", "readonly": false, "engine_class_id": "openai_chat", "organization": "org-123e4567-e89b-12d3-a456-426614174000"}
{}
{
"detail": "<string>"
}
{
"detail": "<string>"
}
Agents
Create Agent Version
Create a new version of an existing agent.
POST
/
v1
/
agents
/
{agent_id}
/
versions
/
curl --request POST \ --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/" \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "prompt": "New version prompt", "description": "Version description" }'
{ "id": "789e1234-e89b-12d3-a456-426614174002", "version_name": "version 2", "description": "Updated version with new features", "input_definitions": [ { "key": "input_text", "description": "Text to process", "data_type": "text/plain" } ], "engine_config": { "model": "gpt-4", "temperature": "0.5" }, "created_at": "2024-01-16T14:20:00Z", "readonly": false, "engine_class_id": "openai_chat", "organization": "org-123e4567-e89b-12d3-a456-426614174000"}
{}
{
"detail": "<string>"
}
{
"detail": "<string>"
}
curl --request POST \ --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/" \ --header "Authorization: Bearer YOUR_API_KEY" \ --header "Content-Type: application/json" \ --data '{ "prompt": "New version prompt", "description": "Version description" }'
Authorizations
Authorization
string
header
required
Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.
Path Parameters
agent_id
string<uuid>
required
A UUID string identifying the base agent.
Query Parameters
organization_id
string<uuid>
Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.
Body
application/json
Serializer for creating new agent versions
version_name
string
Version name for the agent version. Defaults to 'unnamed version' if not provided.
Minimum string length: 1
description
string | null
Description for the agent version.
input_definitions
any
List of input definitions for this agent version. Engines with fixed job inputs (the policy-aware investigation engines) accept only the keys they declare; any additional key is rejected. Per-case detail belongs inside the value of an accepted field, which is free text.
engine_config
any
Engine configuration as a dictionary of string key-value pairs.
post_actions
object[]
write-only
Connector write actions for this version. Omitted: the new version keeps the current version's actions. A list: those become the new version's actions. []: the new version has none.
Show child attributes
Response
Successfully created new agent version.
Serializer for Agent (version) model
id
string<uuid>
required
read-only
name
string
required
read-only
version_name
string
required
Version name for the agent version. Defaults to 'unnamed version' if not provided.
created_at
string<date-time>
required
read-only
engine_class_id
string
required
read-only
Get engine_class_id from base_agent.
engine_name
string
required
read-only
Engine Display Name
supports_memory
boolean
required
read-only
True when this engine has a built-in memory profile, so memory profiles can be configured on it. Independent of whether memory is currently switched on.
input_definitions
object[]
required
List of input definitions for this agent version. Engines with fixed job inputs (the policy-aware investigation engines) accept only the keys they declare; any additional key is rejected. Per-case detail belongs inside the value of an accepted field, which is free text.
Show child attributes
engine_config
any
required
Engine configuration.
post_actions
object[]
required
read-only
Connector write actions configured on this version.
Show child attributes
organization_id
string<uuid>
required
read-only
Organization ID from base_agent.
readonly
boolean
required
read-only
base_agent
object
required
Serializer for BaseAgent (agent config)
Show child attributes
creator
object | null
Show child attributes
description
string
Description of the agent version.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Roe Documentation","colors":{"primary":"#FF6619","light":"#FF8C5A","dark":"#D9530F"},"logo":{"light":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/light.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=d7b4fe21f708298b16c7b5b7af65cdbb","dark":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/dark.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=f3eab0bc8f0dc6aa2bcd39722374dc62"},"favicon":"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/favicon.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=f95b26cc8189388c848892e9d8871685","api":{"openapi":["api-reference/openapi.yml"]},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:support@roe-ai.com","label":"Support"}],"primary":{"type":"button","label":"Workspace","href":"https://app.roe-ai.com"}},"footer":{"socials":{"x":"https://x.com/try_roe_ai","github":"https://github.com/roe-ai","linkedin":"https://www.linkedin.com/company/roe-ai"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/roeaiusers/shared_invite/zt-2m0oa9kj4-wltD91LCeJJR~cN1y1R7JQ"},{"anchor":"Blog","icon":"newspaper","href":"https://roeai.substack.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"roeai","hasAudioNarration":false,"actualSubdomain":"roeai","customDomains":["docs.roe-ai.com"],"gitSource":{"type":"github","owner":"roe-ai","repo":"roe-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6afb935e61bd8823c99566a0","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"Documentation","count":79},{"language":"default","tag":"API Reference","count":58},{"language":"default","tag":"Agents","count":38},{"language":"default","tag":"Release Notes","count":23},{"language":"default","tag":"Workflows","count":14},{"language":"default","tag":"Engines","count":12},{"language":"default","tag":"SDK integration","count":10},{"language":"default","tag":"Policies","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Data Resources","count":9}]},"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":[{"filePath":"style.css","content":".prose ul:has(>li>.rn-tag),ul:has(>li>.rn-tag){list-style:none;padding:0!important;padding-inline-start:0!important;margin-top:1rem;margin-left:0!important}.prose ul>li:has(>.rn-tag),li:has(>.rn-tag){display:grid;grid-template-columns:7.5rem minmax(0, 1fr);column-gap:0.875rem;row-gap:0.5rem;align-items:baseline;justify-items:start;list-style:none;padding:0!important;padding-left:0!important;padding-inline-start:0!important;margin-left:0!important;margin-bottom:1.25rem;font-size:1.0625rem;line-height:1.5;letter-spacing:-0.005em;text-align:left}li:has(>.rn-tag):last-child{margin-bottom:0}li:has(>.rn-tag)::before{content:none}li:has(>.rn-tag)>.rn-tag{justify-self:start}.rn-tag{display:inline-block;box-sizing:border-box;width:fit-content;max-width:7.5rem;padding:0.1875rem 0.625rem;border-radius:9999px;font-size:0.65625rem;font-weight:600;line-height:1.45;letter-spacing:0.09em;text-transform:uppercase;text-align:left;white-space:nowrap;vertical-align:baseline}@media (max-width: 640px){li:has(>.rn-tag){grid-template-columns:1fr;row-gap:0.375rem}.rn-tag{max-width:none}}.rn-tag-agents{background:#FFE6DE;color:#A23B1E}.rn-tag-platform{background:#E3E8F2;color:#2F4868}.rn-tag-integrations{background:#D6EEEA;color:#1F5F58}.rn-tag-sops{background:#E5E1F5;color:#443B85}.rn-tag-qa{background:#DDEEDA;color:#2C6230}.rn-tag-deployment{background:#D9E8F5;color:#1E4D77}.rn-tag-dashboard{background:#F8DEEB;color:#8A3A66}.rn-tag-api{background:#F6EAC9;color:#7A5614}.rn-tag-models{background:#EBDEEF;color:#5E2A7A}.rn-tag-security{background:#F5DCDC;color:#8C2A2A}.rn-tag-workflows{background:#E4EED1;color:#4D6622}"}]}
{"page":{"pagePath":"api-reference/agents/create-agent-version","slug":"/api-reference/agents/create-agent-version","pageMetadata":{"title":"Create Agent Version","openapi":"POST /v1/agents/{agent_id}/versions/","description":"Create a new version of an existing agent.","href":"/api-reference/agents/create-agent-version"},"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: \"Create a new version of an existing agent.\"\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 Agent Version","openapi":"POST /v1/agents/{agent_id}/versions/","description":"Create a new version of an existing agent.","href":"/api-reference/agents/create-agent-version"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,RequestExample}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);return _jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`8`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --data`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"prompt\": \"New version prompt\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"description\": \"Version description\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Agent Version","openapi":"POST /v1/agents/{agent_id}/versions/","description":"Create a new version of an existing agent.","href":"/api-reference/agents/create-agent-version"}}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"8\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> POST\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Authorization: Bearer YOUR_API_KEY\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --header\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --data\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"prompt\": \"New version prompt\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"description\": \"Version description\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"v1_agents_versions_create","description":"Create a new version of an existing agent.","summary":"Create a new agent version.","parameters":["452fc7d0-b845-44f9-94dc-bb204ebc1416","5878303a-479c-4cf7-917d-2d51bfa4f287"],"tags":["v1"],"requestBody":"6477be17-0866-42eb-9a1b-a05310384f94","security":["c4c40d19-e1e4-4029-8129-87e94496fa72"],"responses":{"201":"91c488f9-0d12-43f9-a9f0-3537302fca7d","400":"0fb16e2c-0a87-43c0-940b-c1fffba71469","403":"b4c6c931-7c92-49f5-b7e4-78b3d4d45f8f","404":"8c9918d3-915b-432c-87e9-a53d508c708c"},"method":"post","type":"path","servers":["7238e88e-6be6-474e-b91a-4377e893a821"],"path":"/v1/agents/{agent_id}/versions/","baseUrlOptions":["https://api.roe-ai.com"],"title":"Create a new agent version.","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"dropdown":false,"language":"shellscript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"shellscript","children":{"type":"code","key":null,"ref":null,"props":{"language":"shellscript","numberOfLines":"8","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#953800","--shiki-dark":"#DCDCAA"},"children":"curl"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --request"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" POST"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --url"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --header"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"Authorization: Bearer YOUR_API_KEY\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"6","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --header"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"Content-Type: application/json\""}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"8","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --data"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" '{"}}]}},"\n",{"type":"span","key":"10","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"prompt\": \"New version prompt\","}}}},"\n",{"type":"span","key":"12","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" \"description\": \"Version description\""}}}},"\n",{"type":"span","key":"14","ref":null,"props":{"className":"line","children":{"type":"span","key":null,"ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" }'"}}}},"\n"]}}}},"filename":"cURL"}],"requestExampleType":"mdx","responseExampleType":"generated"},"dependencies":{"parameters":{"452fc7d0-b845-44f9-94dc-bb204ebc1416":{"in":"path","name":"agent_id","schema":{"type":"string","format":"uuid","isRequired":true,"description":"A UUID string identifying the base agent.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"A UUID string identifying the base agent.","required":true},"5878303a-479c-4cf7-917d-2d51bfa4f287":{"name":"organization_id","in":"query","required":false,"schema":{"type":"string","format":"uuid","isRequired":false,"description":"Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint."}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Serializer for creating new agent versions","properties":{"version_name":{"type":"string","minLength":1,"description":"Version name for the agent version. Defaults to 'unnamed version' if not provided.","uniqueKey":"version_name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Description for the agent version.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the agent version.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"input_definitions":{"description":"List of input definitions for this agent version. Engines with fixed job inputs (the policy-aware investigation engines) accept only the keys they declare; any additional key is rejected. Per-case detail belongs inside the value of an accepted field, which is free text.","uniqueKey":"input_definitions","typeLabel":"any"},"engine_config":{"description":"Engine configuration as a dictionary of string key-value pairs.","uniqueKey":"engine_config","typeLabel":"any"},"post_actions":{"type":"array","items":{"type":"object","description":"Schema mirror of PostActionSpec (agents/services/post_actions.py);\ngenerated clients import this component instead of hand-writing it.","properties":{"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].name","typeLabel":"string"},"connection_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"post_actions.items.[INDEX].connection_id","typeLabel":"string\u003cuuid>"},"operation":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].operation","typeLabel":"string"},"trigger_on":{"type":"array","items":{"type":"integer","uniqueKey":"post_actions.items.[INDEX].trigger_on.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].trigger_on","typeLabel":"integer[]"},"param_mappings":{"type":"object","additionalProperties":{"type":"string","minLength":1,"uniqueKey":"post_actions.items.[INDEX].param_mappings.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].param_mappings","typeLabel":"object"}},"required":["connection_id","name","operation","param_mappings","trigger_on"],"uniqueKey":"post_actions.items.[INDEX]","typeLabel":"object"},"writeOnly":true,"description":"Connector write actions for this version. Omitted: the new version keeps the current version's actions. A list: those become the new version's actions. []: the new version has none.","uniqueKey":"post_actions","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"version_name":"\u003cstring>","description":"\u003cstring>","input_definitions":"\u003cunknown>","engine_config":"\u003cunknown>","post_actions":[{"name":"\u003cstring>","connection_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","operation":"\u003cstring>","trigger_on":[123],"param_mappings":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"91c488f9-0d12-43f9-a9f0-3537302fca7d":{"content":{"application/json":{"schema":{"type":"object","description":"Serializer for Agent (version) model","properties":{"id":{"type":"string","format":"uuid","readOnly":true,"isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"version_name":{"type":"string","description":"Version name for the agent version. Defaults to 'unnamed version' if not provided.","isRequired":true,"uniqueKey":"version_name","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"engine_class_id":{"type":"string","description":"Get engine_class_id from base_agent.","readOnly":true,"isRequired":true,"uniqueKey":"engine_class_id","typeLabel":"string"},"engine_name":{"type":"string","description":"Engine Display Name","readOnly":true,"isRequired":true,"uniqueKey":"engine_name","typeLabel":"string"},"supports_memory":{"type":"boolean","readOnly":true,"description":"True when this engine has a built-in memory profile, so memory profiles can be configured on it. Independent of whether memory is currently switched on.","isRequired":true,"uniqueKey":"supports_memory","typeLabel":"boolean"},"input_definitions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The unique identifier for this input definition","isRequired":true,"uniqueKey":"input_definitions.items.[INDEX].key","typeLabel":"string"},"data_type":{"type":"string","description":"MIME type of the input, from the closed DataType set. Use 'text/plain' for ordinary strings such as URLs, names and free text; other values include 'application/pdf', 'application/json', 'image/png', 'audio/mpeg', 'video/mp4' and the wildcards 'text/*', 'image/*', 'audio/*', 'video/*', '*/*'.","isRequired":true,"uniqueKey":"input_definitions.items.[INDEX].data_type","typeLabel":"string"},"description":{"type":"string","description":"Description of what this input is for","isRequired":true,"uniqueKey":"input_definitions.items.[INDEX].description","typeLabel":"string"},"example":{"type":"string","description":"An example value for this input","uniqueKey":"input_definitions.items.[INDEX].example","typeLabel":"string"},"accepts_multiple_files":{"type":"boolean","description":"Whether this input accepts multiple files","uniqueKey":"input_definitions.items.[INDEX].accepts_multiple_files","typeLabel":"boolean"}},"required":["data_type","description","key"],"uniqueKey":"input_definitions.items.[INDEX]","typeLabel":"object"},"description":"List of input definitions for this agent version. Engines with fixed job inputs (the policy-aware investigation engines) accept only the keys they declare; any additional key is rejected. Per-case detail belongs inside the value of an accepted field, which is free text.","isRequired":true,"uniqueKey":"input_definitions","typeLabel":"object[]"},"engine_config":{"description":"Engine configuration.","isRequired":true,"uniqueKey":"engine_config","typeLabel":"any"},"post_actions":{"type":"array","items":{"type":"object","description":"Schema mirror of PostActionSpec (agents/services/post_actions.py);\ngenerated clients import this component instead of hand-writing it.","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"post_actions.items.[INDEX].name","typeLabel":"string"},"connection_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"post_actions.items.[INDEX].connection_id","typeLabel":"string\u003cuuid>"},"operation":{"type":"string","isRequired":true,"uniqueKey":"post_actions.items.[INDEX].operation","typeLabel":"string"},"trigger_on":{"type":"array","items":{"type":"integer","uniqueKey":"post_actions.items.[INDEX].trigger_on.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].trigger_on","typeLabel":"integer[]"},"param_mappings":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"post_actions.items.[INDEX].param_mappings.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"post_actions.items.[INDEX].param_mappings","typeLabel":"object"}},"required":["connection_id","name","operation","param_mappings","trigger_on"],"uniqueKey":"post_actions.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Connector write actions configured on this version.","isRequired":true,"uniqueKey":"post_actions","typeLabel":"object[]"},"organization_id":{"type":"string","format":"uuid","readOnly":true,"description":"Organization ID from base_agent.","isRequired":true,"uniqueKey":"organization_id","typeLabel":"string\u003cuuid>"},"readonly":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"readonly","typeLabel":"boolean"},"base_agent":{"type":"object","description":"Serializer for BaseAgent (agent config)","required":["cache_failed_jobs","created_at","current_version_id","disable_cache","engine_class_id","engine_name","id","job_count","most_recent_job","name","organization_id","skill_generation_state","tags","updated_at"],"properties":{"id":{"type":"string","format":"uuid","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","maxLength":200,"minLength":1,"isRequired":true,"uniqueKey":"base_agent.name","typeLabel":"string"},"disable_cache":{"type":"boolean","description":"Whether to disable job cache fetching for this agent.","isRequired":true,"uniqueKey":"base_agent.disable_cache","typeLabel":"boolean"},"cache_failed_jobs":{"type":"boolean","description":"Whether to cache failed jobs for this agent.","isRequired":true,"uniqueKey":"base_agent.cache_failed_jobs","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid","description":"Organization ID that owns this agent.","isRequired":true,"uniqueKey":"base_agent.organization_id","typeLabel":"string\u003cuuid>"},"engine_class_id":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"base_agent.engine_class_id","typeLabel":"string"},"current_version_id":{"type":"string","format":"uuid","readOnly":true,"description":"UUID of the current agent version.","isRequired":true,"uniqueKey":"base_agent.current_version_id","typeLabel":"string\u003cuuid>"},"job_count":{"oneOf":[{"type":"integer","description":"Served job count: cached baseline + live delta, annotated by the views\nas ``job_count``. ``None`` when stats weren't fetched (the list can be\nrequested with ``include_job_stats=false``; use /agents/job-stats/).","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.job_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Served job count: cached baseline + live delta, annotated by the views\nas ``job_count``. ``None`` when stats weren't fetched (the list can be\nrequested with ``include_job_stats=false``; use /agents/job-stats/).","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.job_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"base_agent.job_count","typeLabel":"integer | null"},"most_recent_job":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.most_recent_job.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.most_recent_job.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"base_agent.most_recent_job","typeLabel":"string\u003cdate-time> | null"},"engine_name":{"type":"string","description":"Engine Display Name","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.engine_name","typeLabel":"string"},"tags":{"type":"array","items":{"type":"object","description":"Serializer for AgentTag model","properties":{"id":{"type":"string","format":"uuid","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].name","typeLabel":"string"},"color":{"enum":["blue","green","purple","orange","red","yellow","gray","pink"],"type":"string","description":"* `blue` - Blue\n* `green` - Green\n* `purple` - Purple\n* `orange` - Orange\n* `red` - Red\n* `yellow` - Yellow\n* `gray` - Gray\n* `pink` - Pink","isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].color","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"creator":{"oneOf":[{"type":"integer","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].creator.oneOf.0","typeLabel":"integer"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].creator.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].creator","typeLabel":"integer | null"},"usage_count":{"type":"integer","description":"Count of agents using this tag","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].usage_count","typeLabel":"integer"},"private":{"type":"boolean","readOnly":true,"description":"Visible only to its owner (the Pinned group).","isRequired":true,"uniqueKey":"base_agent.tags.items.[INDEX].private","typeLabel":"boolean"}},"required":["color","created_at","creator","id","name","private","usage_count"],"uniqueKey":"base_agent.tags.items.[INDEX]","typeLabel":"object"},"readOnly":true,"isRequired":true,"uniqueKey":"base_agent.tags","typeLabel":"object[]"},"skill_generation_state":{"oneOf":[{"type":"string","description":"* `generating` - generating\n* `failed` - failed","enum":["generating","failed"],"isRequired":true,"uniqueKey":"base_agent.skill_generation_state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"base_agent.skill_generation_state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"base_agent.skill_generation_state","typeLabel":"enum\u003cstring> | null"},"creator":{"oneOf":[{"type":"object","required":["display_name","email","id"],"properties":{"id":{"type":"integer","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.creator.oneOf.0.id","typeLabel":"integer"},"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"base_agent.creator.oneOf.0.email","typeLabel":"string\u003cemail>"},"display_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"base_agent.creator.oneOf.0.display_name","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"base_agent.creator.oneOf.0.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"base_agent.creator.oneOf.0.last_name","typeLabel":"string"}},"uniqueKey":"base_agent.creator.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"base_agent.creator.oneOf.1","typeLabel":"null"}],"uniqueKey":"base_agent.creator","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"base_agent","typeLabel":"object"},"creator":{"oneOf":[{"type":"object","required":["display_name","email","id"],"properties":{"id":{"type":"integer","readOnly":true,"isRequired":true,"uniqueKey":"creator.oneOf.0.id","typeLabel":"integer"},"email":{"type":"string","format":"email","title":"Email address","maxLength":254,"isRequired":true,"uniqueKey":"creator.oneOf.0.email","typeLabel":"string\u003cemail>"},"display_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"creator.oneOf.0.display_name","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"uniqueKey":"creator.oneOf.0.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"creator.oneOf.0.last_name","typeLabel":"string"}},"uniqueKey":"creator.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"creator.oneOf.1","typeLabel":"null"}],"uniqueKey":"creator","typeLabel":"object | null"},"description":{"type":"string","description":"Description of the agent version.","uniqueKey":"description","typeLabel":"string"}},"required":["base_agent","created_at","engine_class_id","engine_config","engine_name","id","input_definitions","name","organization_id","post_actions","readonly","supports_memory","version_name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"789e1234-e89b-12d3-a456-426614174002","version_name":"version 2","description":"Updated version with new features","input_definitions":[{"key":"input_text","description":"Text to process","data_type":"text/plain"}],"engine_config":{"model":"gpt-4","temperature":"0.5"},"created_at":"2024-01-16T14:20:00Z","readonly":false,"engine_class_id":"openai_chat","organization":"org-123e4567-e89b-12d3-a456-426614174000"}}},"exampleType":"examples"}},"description":"Successfully created new agent version.","exampleType":"examples"},"0fb16e2c-0a87-43c0-940b-c1fffba71469":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"additionalProperties.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"additionalProperties.oneOf.0","typeLabel":"string[]"},{"type":"string","uniqueKey":"additionalProperties.oneOf.1","typeLabel":"string"}],"uniqueKey":"additionalProperties","typeLabel":"string[] | string"},"description":"Validation failure: a map of field name to a list of error messages (DRF serializers) or a single message (e.g. organization_id validation).","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"description":"Invalid request data.","exampleType":"generated"},"b4c6c931-7c92-49f5-b7e4-78b3d4d45f8f":{"content":{"application/json":{"schema":{"type":"object","description":"DRF default error body: NotFound, PermissionDenied, Http404, etc.","properties":{"detail":{"type":"string","description":"Human-readable error detail","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Access to the Agents feature is forbidden or permission to access this agent denied.","exampleType":"generated"},"8c9918d3-915b-432c-87e9-a53d508c708c":{"content":{"application/json":{"schema":{"type":"object","description":"DRF default error body: NotFound, PermissionDenied, Http404, etc.","properties":{"detail":{"type":"string","description":"Human-readable error detail","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Agent not found.","exampleType":"generated"}},"security":{"c4c40d19-e1e4-4029-8129-87e94496fa72":{"apiKeyAuth":{"type":"http","scheme":"bearer","description":"Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"7238e88e-6be6-474e-b91a-4377e893a821":{"url":"https://api.roe-ai.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"roeai","siteName":"Roe Documentation","title":"Create Agent Version - Roe Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T17:00:49.247Z","originalFileLocation":"api-reference/agents/create-agent-version.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=\"light\"}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=\"Create a new version of an existing agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Roe Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Agent Version - Roe Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new version of an existing agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Roe Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.roe-ai.com/api-reference/agents/create-agent-version\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://roeai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Create+Agent+Version\u0026amp;description=Create+a+new+version+of+an+existing+agent.\u0026amp;theme=f7a915f73e99edbffff5a149\u0026amp;signature=a1712e70c00bb6380e5b3d98961bf4c085c62d5b9875ea3b3b3f5e656793115b\">\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 Agent Version - Roe Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new version of an existing agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://roeai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Create+Agent+Version\u0026amp;description=Create+a+new+version+of+an+existing+agent.\u0026amp;theme=f7a915f73e99edbffff5a149\u0026amp;signature=a1712e70c00bb6380e5b3d98961bf4c085c62d5b9875ea3b3b3f5e656793115b\">\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/roeai/fPmAFS4J5dj6_hvQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Roe Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6619\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.roe-ai.com/api-reference/agents/create-agent-version\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/create-agent-version.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.roe-ai.com/#organization\",\"name\":\"Roe Documentation\",\"url\":\"https://docs.roe-ai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/roeai/fwCD8GI-1nfdsPAX/logo/light.svg?fit=max\u0026auto=format\u0026n=fwCD8GI-1nfdsPAX\u0026q=85\u0026s=d7b4fe21f708298b16c7b5b7af65cdbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.roe-ai.com#website\",\"name\":\"Roe Documentation\",\"url\":\"https://docs.roe-ai.com\",\"publisher\":{\"@id\":\"https://docs.roe-ai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version#webpage\",\"url\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version\",\"name\":\"Create Agent Version\",\"description\":\"Create a new version of an existing agent.\",\"dateModified\":\"2026-01-06T17:00:49.247Z\",\"isPartOf\":{\"@id\":\"https://docs.roe-ai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.roe-ai.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Agent Version\",\"item\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version#apireference\",\"headline\":\"Create Agent Version\",\"name\":\"Create Agent Version\",\"description\":\"Create a new version of an existing agent.\",\"url\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version\",\"mainEntityOfPage\":{\"@id\":\"https://docs.roe-ai.com/api-reference/agents/create-agent-version#webpage\"},\"dateModified\":\"2026-01-06T17:00:49.247Z\",\"publisher\":{\"@id\":\"https://docs.roe-ai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.roe-ai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Roe Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Roe Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agents/create-agent-version.md","siteName":"Roe Documentation","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","href":"https://join.slack.com/t/roeaiusers/shared_invite/zt-2m0oa9kj4-wltD91LCeJJR~cN1y1R7JQ"},{"anchor":"Blog","icon":"newspaper","href":"https://roeai.substack.com/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"SDK integration","pages":[{"title":"SDK integration","href":"/api-reference/sdk-integration"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Examples","href":"/api-reference/examples"}]},{"group":"Agents","pages":[{"title":"List Agents","openapi":"GET /v1/agents/","href":"/api-reference/agents/list-agents"},{"title":"Create Agent","openapi":"POST /v1/agents/","href":"/api-reference/agents/create-agent"},{"title":"Retrieve an Agent","openapi":"GET /v1/agents/{agent_id}/","href":"/api-reference/agents/retrieve-agent"},{"title":"Update an Agent's Settings","openapi":"PUT /v1/agents/{agent_id}/","href":"/api-reference/agents/update-agent-settings"},{"title":"Delete an Agent","openapi":"DELETE /v1/agents/{agent_id}/","href":"/api-reference/agents/delete-agent"},{"title":"Duplicate an Agent","openapi":"POST /v1/agents/{agent_id}/duplicate/","href":"/api-reference/agents/duplicate-agent"},{"title":"List Agent Versions","openapi":"GET /v1/agents/{agent_id}/versions/","description":"Retrieve a list of versions for a specific agent.","href":"/api-reference/agents/list-agent-versions"},{"title":"Create Agent Version","openapi":"POST /v1/agents/{agent_id}/versions/","href":"/api-reference/agents/create-agent-version"},{"title":"Retrieve an Agent Version","openapi":"GET /v1/agents/{agent_id}/versions/{agent_version_id}/","description":"Retrieve details of a specific agent version.","href":"/api-reference/agents/retrieve-agent-version"},{"title":"Retrieve Current Agent Version","openapi":"GET /v1/agents/{agent_id}/versions/current/","href":"/api-reference/agents/retrieve-agent-current-version"},{"title":"Run Agent","openapi":"POST /v1/agents/run/{agent_id}/","href":"/api-reference/agents/run"},{"title":"Run Agent Async","openapi":"POST /v1/agents/run/{agent_id}/async/","href":"/api-reference/agents/run-async"},{"title":"Agent Job Status","openapi":"GET /v1/agents/jobs/{job_id}/status/","href":"/api-reference/agents/job-status"},{"title":"Agent Job Result","openapi":"GET /v1/agents/jobs/{agent_job_id}/result/","href":"/api-reference/agents/job-result"},{"title":"List Agent's Jobs","openapi":"GET /v1/agents/{agent_id}/jobs/","href":"/api-reference/agents/list-agent-jobs"}]},{"group":"Workflows","pages":[{"title":"Workflows","href":"/api-reference/workflows/introduction"},{"title":"List Workflows","openapi":"GET /v1/workflows/","href":"/api-reference/workflows/list-workflows"},{"title":"Create Workflow","openapi":"POST /v1/workflows/","href":"/api-reference/workflows/create-workflow"},{"title":"Retrieve Workflow","openapi":"GET /v1/workflows/{workflow_id}/","href":"/api-reference/workflows/retrieve-workflow"},{"title":"Rename Workflow","openapi":"PATCH /v1/workflows/{workflow_id}/","href":"/api-reference/workflows/rename-workflow"},{"title":"Delete Workflow","openapi":"DELETE /v1/workflows/{workflow_id}/","href":"/api-reference/workflows/delete-workflow"},{"title":"List Workflow Versions","openapi":"GET /v1/workflows/{workflow_id}/versions/","href":"/api-reference/workflows/list-workflow-versions"},{"title":"Save Workflow Version","openapi":"POST /v1/workflows/{workflow_id}/versions/","href":"/api-reference/workflows/create-workflow-version"},{"title":"Retrieve Workflow Version","openapi":"GET /v1/workflows/{workflow_id}/versions/{version_id}/","href":"/api-reference/workflows/retrieve-workflow-version"},{"title":"Set Current Version","openapi":"POST /v1/workflows/{workflow_id}/versions/{version_id}/set-current/","href":"/api-reference/workflows/set-current-version"},{"title":"Run Workflow","openapi":"POST /v1/workflows/{workflow_id}/runs/","href":"/api-reference/workflows/run-workflow"},{"title":"Run Workflow in Batch","openapi":"POST /v1/workflows/{workflow_id}/runs/batch/","href":"/api-reference/workflows/run-workflow-batch"},{"title":"List Workflow Runs","openapi":"GET /v1/workflows/{workflow_id}/runs/","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Retrieve Workflow Run","openapi":"GET /v1/workflows/runs/{run_id}/","href":"/api-reference/workflows/retrieve-workflow-run"}]},{"group":"Database","pages":[{"title":"Run Query","openapi":"POST /v1/database/query/","href":"/api-reference/database/query"},{"title":"Run Query Async","openapi":"POST /v1/database/query/async/","href":"/api-reference/database/query-async"},{"title":"Query Status","openapi":"GET /v1/database/query/{worksheet_query_id}/status/","href":"/api-reference/database/query-status"},{"title":"Query Result","openapi":"GET /v1/database/query/{worksheet_query_id}/result/","href":"/api-reference/database/query-result"}]},{"group":"Roe Datasets","pages":[{"title":"List Datasets","openapi":"GET /v1/datasets/","href":"/api-reference/roe-dataset/list"},{"title":"Create a Dataset","openapi":"POST /v1/datasets/","href":"/api-reference/roe-dataset/create"},{"title":"Delete a Dataset","openapi":"DELETE /v1/datasets/{dataset_id}/","href":"/api-reference/roe-dataset/delete-dataset"},{"title":"Upload File","openapi":"POST /v1/datasets/files/upload/","href":"/api-reference/roe-dataset/file-upload"},{"title":"Download File","openapi":"GET /v1/datasets/files/{file_str}/download/","href":"/api-reference/roe-dataset/file-download"},{"title":"Delete a File","openapi":"DELETE /v1/datasets/{dataset_id}/files/{id}/","href":"/api-reference/roe-dataset/delete-file"}]},{"group":"Policies","pages":[{"title":"List Policies","openapi":"GET /policies/","href":"/api-reference/policies/list-policies"},{"title":"Create Policy","openapi":"POST /policies/","href":"/api-reference/policies/create-policy"},{"title":"Retrieve Policy","openapi":"GET /policies/{id}/","href":"/api-reference/policies/retrieve-policy"},{"title":"Update Policy","openapi":"PUT /policies/{id}/","href":"/api-reference/policies/update-policy"},{"title":"Delete Policy","openapi":"DELETE /policies/{id}/","href":"/api-reference/policies/delete-policy"},{"title":"List Policy Versions","openapi":"GET /policies/{policy_id}/versions/","href":"/api-reference/policies/list-policy-versions"},{"title":"Create Policy Version","openapi":"POST /policies/{policy_id}/versions/","href":"/api-reference/policies/create-policy-version"},{"title":"Retrieve Policy Version","openapi":"GET /policies/versions/{id}/","href":"/api-reference/policies/retrieve-policy-version"},{"title":"Set Current Version","openapi":"PATCH /policies/{policy_id}/set-current-version/{version_id}/","href":"/api-reference/policies/set-current-version"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /webhooks/","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","openapi":"POST /webhooks/","href":"/api-reference/webhooks/create-webhook"},{"title":"Retrieve Webhook","openapi":"GET /webhooks/{webhook_id}/","href":"/api-reference/webhooks/retrieve-webhook"},{"title":"Update Webhook","openapi":"PATCH /webhooks/{webhook_id}/","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","openapi":"DELETE /webhooks/{webhook_id}/","href":"/api-reference/webhooks/delete-webhook"},{"title":"List Webhook Agents","openapi":"GET /webhooks/{webhook_id}/agents/","href":"/api-reference/webhooks/list-webhook-agents"},{"title":"Link Agents to Webhook","openapi":"POST /webhooks/{webhook_id}/agents/","href":"/api-reference/webhooks/link-agents"},{"title":"Unlink Agent from Webhook","openapi":"DELETE /webhooks/{webhook_id}/agents/{agent_webhook_id}/","href":"/api-reference/webhooks/unlink-agent"}]}]},{"tab":"SQL Reference","pages":[{"title":"SQL Reference","href":"/sql-reference/introduction"}]}]},"basePath":"","title":"Create Agent Version - Roe Documentation","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}