What the agent may reach outside the workspace: your own functions, MCP servers, and which built-ins. Everything inside the workspace — shell, files, git — is always there and is not configured here.
How freely sessions from this agent act. Omitted means the agent says nothing about approvals and a session falls through to auto — the mode that acts without asking. A session may override it per field, the same way it overrides model.
Rules sessions from this agent start with. Replaced whole by a session that sends its own, never merged — a half-merged rule list is ambiguous about which half won.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Gobare Agent API Docs","colors":{"primary":"#7a766d","light":"#f4ebdc","dark":"#111110"},"logo":{"light":"https://mintcdn.com/gobare-dev/Ph-62MdyPaY-BauC/logo/ink-dark.svg?fit=max\u0026auto=format\u0026n=Ph-62MdyPaY-BauC\u0026q=85\u0026s=b0cb33c0a05e08e6d5535259331c08c1","dark":"https://mintcdn.com/gobare-dev/Ph-62MdyPaY-BauC/logo/ink-light.svg?fit=max\u0026auto=format\u0026n=Ph-62MdyPaY-BauC\u0026q=85\u0026s=f6887af724be25489e30ec3edd44cb35"},"favicon":"https://mintcdn.com/gobare-dev/Ph-62MdyPaY-BauC/favicon.png?fit=max\u0026auto=format\u0026n=Ph-62MdyPaY-BauC\u0026q=85\u0026s=04dabf5cd88a4daa0950139b6ef9b66b","navbar":{"links":[{"href":"https://gobare.dev","label":"Gobare"},{"href":"https://github.com/MishaBear94/gobare_tools","label":"GitHub"}],"primary":{"type":"button","label":"Log in","href":"https://app.gobare.dev"}},"footer":{"socials":{"website":"https://gobare.dev","github":"https://github.com/MishaBear94/gobare_tools","x":"https://x.com/markovvxow","discord":"https://discord.gg/fTkEJQNmjg"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gobare-dev","hasAudioNarration":false,"actualSubdomain":"gobare-dev","customDomains":["docs.gobare.dev"],"gitSource":{"type":"github","owner":"mishabear94","repo":"gobare_docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aba7ecdb873ba1b8696bd99","collectionId":"66c4c816-726c-4dcd-aefa-e46ddf65fb1c","liveDeploymentHistoryId":"6aba7ecdb873ba1b8696bd99","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6abb2f4a67be2e4d304d95ee","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Endpoints","count":44},{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Start here","count":9},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Running a session","count":7},{"language":"default","tag":"About this API","count":4},{"language":"default","tag":"When things go wrong","count":3},{"language":"default","tag":"API reference","count":2},{"language":"default","tag":"Client libraries","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/create-or-replace-an-agent","slug":"/api-reference/create-or-replace-an-agent","pageMetadata":{"title":"Create or replace an agent","description":"Create or replace a named agent.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/create-or-replace-an-agent","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: \"Create or replace a named 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 or replace an agent","description":"Create or replace a named agent.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/create-or-replace-an-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create or replace an agent","description":"Create or replace a named agent.","operationId":"post_agents","security":["b66b57eb-ed39-4f39-9afe-971db04ac04c"],"parameters":["c175c6ed-0217-437d-8295-04e0aa7688c0"],"x-required-scope":"sessions:write","requestBody":"9801d4f4-7d99-4c10-b34b-5e632a9e5065","responses":{"201":"ebbaba52-61b4-4b82-a1ff-32851532aadb","400":"c16ecbf0-f707-465b-b648-c637da0881c6","401":"eb2de69b-e0da-4888-a7d7-c46668f3843e","403":"de8e6c05-10cf-475b-82c5-6d803c768e2f","404":"788afb8c-1cfd-41de-a213-3dd287b636e0","409":"80ea490b-ed49-4874-ba46-388ca3dfd8f7","429":"588d67c5-fa0e-4c65-b416-3ec3f3fe21ae","500":"894f1b21-b99a-441a-92d6-39a10258fb8a"},"method":"post","type":"path","servers":["4214d7e8-ac0f-452f-9246-001c2ec9e7f9"],"path":"/v1/agents","baseUrlOptions":["https://api.{domain}"],"title":"Create or replace an agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c175c6ed-0217-437d-8295-04e0aa7688c0":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Retrying with the same key replays the first answer instead of acting again.","uniqueKey":"","typeLabel":"string"},"description":"Retrying with the same key replays the first answer instead of acting again."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","example":{"name":"reviewer","model":"MiniMax-M3","instructions":"Review diffs. Never modify files."},"required":["name"],"properties":{"name":{"type":"string","description":"Yours, for recognising it.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"model":{"type":"string","description":"Must be one the chosen credential runs. A session started from this agent may override it.","uniqueKey":"model","typeLabel":"string"},"model_credential_id":{"type":"string","description":"Omit to use the organization's default.","uniqueKey":"model_credential_id","typeLabel":"string"},"instructions":{"type":"string","maxLength":32000,"description":"Standing instructions every session started from this agent begins with.","uniqueKey":"instructions","typeLabel":"string"},"tools":{"type":"array","items":{"type":"object","description":"One tool. `type` decides which shape applies; the fields of another are refused rather than ignored. `function` and `mcp` need a `name`; the sandbox's own networked tools are named by their `type` alone and take no other field. Naming any of the latter narrows the session to exactly the ones listed — it cannot enable one this deployment has turned off, and an empty list is a session with no way out to the network.","required":["type"],"properties":{"type":{"type":"string","enum":["function","mcp","web_search","web_fetch","image_search","browse","browser_act","screenshot"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"`function` and `mcp` only, and required for both. What the agent calls it.","uniqueKey":"tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"`function` only. Read by the model to decide when to call it.","uniqueKey":"tools.items.[INDEX].description","typeLabel":"string"},"parameters":{"type":"object","description":"`function` only. JSON Schema for the arguments.","uniqueKey":"tools.items.[INDEX].parameters","typeLabel":"object"},"timeout_seconds":{"type":"integer","description":"`function` only. How long a required action may stay unanswered.","uniqueKey":"tools.items.[INDEX].timeout_seconds","typeLabel":"integer"},"url":{"type":"string","description":"`mcp` only. http or https endpoint of the server.","uniqueKey":"tools.items.[INDEX].url","typeLabel":"string"},"command":{"type":"string","description":"`mcp` only. A server started inside the workspace instead of reached over the network.","uniqueKey":"tools.items.[INDEX].command","typeLabel":"string"},"args":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].args.items.[INDEX]","typeLabel":"string"},"description":"`mcp` only. Arguments for `command`.","uniqueKey":"tools.items.[INDEX].args","typeLabel":"string[]"},"allowed_tools":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].allowed_tools.items.[INDEX]","typeLabel":"string"},"description":"`mcp` only. Narrow the server to these tool names.","uniqueKey":"tools.items.[INDEX].allowed_tools","typeLabel":"string[]"},"required":{"type":"boolean","description":"`mcp` only. `true` fails the session loudly when the server will not connect; `false` lets the turn continue with fewer tools and an `mcp.unavailable` event. Must be a boolean — a string is refused rather than read as false.","uniqueKey":"tools.items.[INDEX].required","typeLabel":"boolean"},"authorization":{"type":"string","description":"`mcp` only. Sent to the server, never returned; a read-back names it under `redacted`.","uniqueKey":"tools.items.[INDEX].authorization","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"tools.items.[INDEX].headers.additionalProperties","typeLabel":"string"},"description":"`mcp` only. Also withheld from a read-back.","uniqueKey":"tools.items.[INDEX].headers","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"description":"What the agent may reach outside the workspace: your own functions, MCP servers, and which built-ins. Everything inside the workspace — shell, files, git — is always there and is not configured here.","uniqueKey":"tools","typeLabel":"object[]"},"text":{"type":"object","description":"Shaping the final message: how much it says, and whether it must conform to a JSON Schema.","properties":{"verbosity":{"type":"string","enum":["low","medium","high"],"description":"How much the agent says when it is done.","uniqueKey":"text.verbosity","typeLabel":"enum\u003cstring>"},"format":{"type":"object","description":"Asked for, not enforced — see design-decisions.","properties":{"type":{"type":"string","const":"json_schema","uniqueKey":"text.format.type","typeLabel":"string"},"schema":{"type":"object","description":"JSON Schema the final message should conform to.","uniqueKey":"text.format.schema","typeLabel":"object"}},"uniqueKey":"text.format","typeLabel":"object"}},"uniqueKey":"text","typeLabel":"object"},"approval_mode":{"type":"string","enum":["auto","per_step","read_only","plan"],"description":"How freely sessions from this agent act. Omitted means the agent says nothing about approvals and a session falls through to `auto` — the mode that acts without asking. A session may override it per field, the same way it overrides `model`.","uniqueKey":"approval_mode","typeLabel":"enum\u003cstring>"},"permission_rules":{"type":"array","items":{"type":"object","uniqueKey":"permission_rules.items.[INDEX]","typeLabel":"object"},"description":"Rules sessions from this agent start with. Replaced whole by a session that sends its own, never merged — a half-merged rule list is ambiguous about which half won.","uniqueKey":"permission_rules","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"reviewer","model":"MiniMax-M3","instructions":"Review diffs. Never modify files."}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ebbaba52-61b4-4b82-a1ff-32851532aadb":{"description":"Create or replace a named agent.","content":{"application/json":{"schema":{"type":"object","required":["object","id","name"],"properties":{"object":{"type":"string","const":"agent","description":"Always `agent`. Names the shape, so a value can be identified without knowing which call returned it.","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"id":{"type":"string","description":"Ours. Pass it as `agent.id` when creating a session.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"Yours, for recognising it. Not an identifier.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"The model sessions from this agent run on, unless they override it.","uniqueKey":"model.oneOf.0","typeLabel":"string"},{"type":"null","description":"The model sessions from this agent run on, unless they override it.","uniqueKey":"model.oneOf.1","typeLabel":"null"}],"uniqueKey":"model","typeLabel":"string | null"},"model_credential_id":{"oneOf":[{"type":"string","description":"The connection to run on. Null uses the organization's default.","uniqueKey":"model_credential_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connection to run on. Null uses the organization's default.","uniqueKey":"model_credential_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"model_credential_id","typeLabel":"string | null"},"instructions":{"oneOf":[{"type":"string","maxLength":32000,"description":"Standing instructions given to every session started from this agent.","uniqueKey":"instructions.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":32000,"description":"Standing instructions given to every session started from this agent.","uniqueKey":"instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructions","typeLabel":"string | null"},"tools":{"type":"array","items":{"type":"object","required":["type","name"],"properties":{"type":{"type":"string","enum":["mcp","function"],"isRequired":true,"uniqueKey":"tools.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Unique across both types: the agent sees one list.","isRequired":true,"uniqueKey":"tools.items.[INDEX].name","typeLabel":"string"},"url":{"type":"string","description":"mcp: the server's address. Exclusive with `command`.","uniqueKey":"tools.items.[INDEX].url","typeLabel":"string"},"command":{"type":"string","description":"mcp: a command run inside the sandbox. Exclusive with `url`.","uniqueKey":"tools.items.[INDEX].command","typeLabel":"string"},"args":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].args.items.[INDEX]","typeLabel":"string"},"description":"mcp: arguments for `command`.","uniqueKey":"tools.items.[INDEX].args","typeLabel":"string[]"},"allowed_tools":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].allowed_tools.items.[INDEX]","typeLabel":"string"},"description":"mcp: restrict the agent to these tools from this server. Absent means all of them.","uniqueKey":"tools.items.[INDEX].allowed_tools","typeLabel":"string[]"},"required":{"type":"boolean","description":"mcp: the session fails if this server will not connect. Absent means optional, which produces an `mcp.unavailable` event instead.","uniqueKey":"tools.items.[INDEX].required","typeLabel":"boolean"},"redacted":{"type":"array","items":{"type":"string","uniqueKey":"tools.items.[INDEX].redacted.items.[INDEX]","typeLabel":"string"},"description":"Names of the secret values withheld from this response, such as `authorization` or `headers.x-api-key`. Not a request field: sending it back is refused, so an edited read-back cannot silently drop your credentials.","uniqueKey":"tools.items.[INDEX].redacted","typeLabel":"string[]"},"description":{"type":"string","description":"function: what the function is for. The model reads it.","uniqueKey":"tools.items.[INDEX].description","typeLabel":"string"},"parameters":{"type":"object","description":"function: a JSON Schema for the arguments. Carried unexamined.","uniqueKey":"tools.items.[INDEX].parameters","typeLabel":"object"},"timeout_seconds":{"type":"integer","description":"function: how long to wait for your process to answer this call.","uniqueKey":"tools.items.[INDEX].timeout_seconds","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"description":"Tools every session started from this agent gets, unless it replaces them. Secrets are withheld — see `redacted` on an entry.","uniqueKey":"tools","typeLabel":"object[]"},"text":{"oneOf":[{"type":"object","description":"Output shaping copied into every session started from this agent.","uniqueKey":"text.oneOf.0","typeLabel":"object"},{"type":"null","description":"Output shaping copied into every session started from this agent.","uniqueKey":"text.oneOf.1","typeLabel":"null"}],"uniqueKey":"text","typeLabel":"object | null"},"created_at":{"type":"integer","description":"Unix milliseconds.","uniqueKey":"created_at","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"agent","id":"\u003cstring>","name":"\u003cstring>","model":"\u003cstring>","model_credential_id":"\u003cstring>","instructions":"\u003cstring>","tools":[{"type":"mcp","name":"\u003cstring>","url":"\u003cstring>","command":"\u003cstring>","args":["\u003cstring>"],"allowed_tools":["\u003cstring>"],"required":true,"redacted":["\u003cstring>"],"description":"\u003cstring>","parameters":{},"timeout_seconds":123}],"text":{},"created_at":123}}},"exampleType":"generated"}},"exampleType":"generated"},"c16ecbf0-f707-465b-b648-c637da0881c6":{"description":"`invalid_request`. A field this endpoint does not read, a field of the wrong shape, a query parameter it does not take, or a body past the size ceiling. Refused rather than ignored: a setting you believe you made is one we really made.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"eb2de69b-e0da-4888-a7d7-c46668f3843e":{"description":"The access token is missing, unrecognised, expired or revoked.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"de8e6c05-10cf-475b-82c5-6d803c768e2f":{"description":"The token is valid but may not perform this call. The message names the scope it wanted.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"788afb8c-1cfd-41de-a213-3dd287b636e0":{"description":"No such endpoint, or the public API is not enabled on this deployment.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"80ea490b-ed49-4874-ba46-388ca3dfd8f7":{"description":"The session's state does not allow this call, or an identical request is already in flight under the same Idempotency-Key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"588d67c5-fa0e-4c65-b416-3ec3f3fe21ae":{"description":"`rate_limit_exceeded` — the token is past its allowance for this bucket; honour `Retry-After`. Or `queue_full` — too many messages are already waiting behind the current turn. Branch on `code`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"894f1b21-b99a-441a-92d6-39a10258fb8a":{"description":"An unexpected error. Quote the request id.","content":{"application/json":{"schema":{"type":"object","required":["error"],"description":"Every refusal this API makes, in one shape.","properties":{"error":{"description":"Always present on a failure, and the only thing present.","type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["invalid_request","authentication_error","permission_denied","not_found","method_not_allowed","conflict","queue_full","rate_limit_exceeded","project_limit_exceeded","context_length_exceeded","provider_error","provider_unauthorized","sandbox_error","sandbox_unavailable","directory_unavailable","workspace_recovery_failed","bridge_incompatible","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","description":"Also on the x-request-id header. Quote it when reporting a problem.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b66b57eb-ed39-4f39-9afe-971db04ac04c":{"accessToken":{"type":"http","scheme":"bearer","description":"A `gbr_pat_` access token. Scopes are recorded on the token when it is minted.","scopes":[]}}},"servers":{"4214d7e8-ac0f-452f-9246-001c2ec9e7f9":{"url":"https://api.{domain}","variables":{"domain":{"default":"gobare.dev"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A `gbr_pat_` access token. Scopes are recorded on the token when it is minted.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A `gbr_pat_` access token. Scopes are recorded on the token when it is minted.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"accessToken","name":"Authorization"}],"title":"accessToken"}]},"originalFileLocation":"openapi.json"},"subdomain":"gobare-dev","siteName":"Gobare Agent API Docs","title":"Create or replace an agent - Gobare Agent API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-25T10:12:33.396Z","originalFileLocation":"api-reference/create-or-replace-an-agent.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=\"Create or replace a named agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gobare Agent API 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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_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/gobare-dev/DajiJMR4Tez08wMz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create or replace an agent - Gobare Agent API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create or replace a named agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gobare Agent API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gobare-dev.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Create+or+replace+an+agent\u0026amp;description=Create+or+replace+a+named+agent.\u0026amp;theme=6f5c05db30b78253e714dbc4\u0026amp;signature=5b408c5ad71e3fe25961d1fa17d4acbc17d888fb3ddc8b0c901ce7ef529a7106\">\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 or replace an agent - Gobare Agent API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create or replace a named agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gobare-dev.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Create+or+replace+an+agent\u0026amp;description=Create+or+replace+a+named+agent.\u0026amp;theme=6f5c05db30b78253e714dbc4\u0026amp;signature=5b408c5ad71e3fe25961d1fa17d4acbc17d888fb3ddc8b0c901ce7ef529a7106\">\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/gobare-dev/DajiJMR4Tez08wMz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gobare Agent API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7a766d\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-or-replace-an-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gobare.dev/#organization\",\"name\":\"Gobare Agent API Docs\",\"url\":\"https://docs.gobare.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gobare-dev/Ph-62MdyPaY-BauC/logo/ink-dark.svg?fit=max\u0026auto=format\u0026n=Ph-62MdyPaY-BauC\u0026q=85\u0026s=b0cb33c0a05e08e6d5535259331c08c1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gobare.dev#website\",\"name\":\"Gobare Agent API Docs\",\"url\":\"https://docs.gobare.dev\",\"publisher\":{\"@id\":\"https://docs.gobare.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent#webpage\",\"url\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent\",\"name\":\"Create or replace an agent\",\"description\":\"Create or replace a named agent.\",\"dateModified\":\"2026-09-25T10:12:33.396Z\",\"isPartOf\":{\"@id\":\"https://docs.gobare.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.gobare.dev/api-reference/check-the-access-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.gobare.dev/api-reference/check-the-access-token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create or replace an agent\",\"item\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent#apireference\",\"headline\":\"Create or replace an agent\",\"name\":\"Create or replace an agent\",\"description\":\"Create or replace a named agent.\",\"url\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gobare.dev/api-reference/create-or-replace-an-agent#webpage\"},\"dateModified\":\"2026-09-25T10:12:33.396Z\",\"publisher\":{\"@id\":\"https://docs.gobare.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gobare.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gobare Agent API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gobare Agent API Docs","nav":{"global":null,"groups":[{"group":"Start here","pages":[{"title":"Gobare Agent API","href":"/index"},{"title":"The agent is pi","href":"/pi"},{"title":"How Gobare is different","href":"/why-gobare"},{"title":"Build without writing code","href":"/without-code"},{"title":"Quickstart","href":"/quickstart"},{"title":"Production integration","href":"/production-integration"},{"title":"Model credentials: bring your own key","sidebarTitle":"Model credentials","href":"/model-credentials"},{"title":"Sessions","href":"/sessions"},{"title":"Agents","href":"/saved-agents"}]},{"group":"Running a session","pages":[{"title":"Input","href":"/input"},{"title":"Events: a resumable agent event stream","sidebarTitle":"Events","href":"/events"},{"title":"Tools: your functions, MCP servers, and a browser in the sandbox","sidebarTitle":"Tools","href":"/tools"},{"title":"Required actions","href":"/required-actions"},{"title":"Webhooks for long-running agents","sidebarTitle":"Webhooks","href":"/webhooks"},{"title":"Idempotency","href":"/idempotency"},{"title":"Preview","href":"/preview"}]},{"group":"Guides","pages":[{"title":"Guides","href":"/guides"},{"title":"Turn documents into structured JSON","href":"/guides/extracting-structured-data"},{"title":"Put an agent behind your own API","href":"/guides/an-agent-behind-your-api"},{"title":"Human-in-the-loop for agents: require approval over an API","href":"/guides/approvals-in-your-product"},{"title":"Stream the agent's progress into your UI","href":"/guides/showing-the-agents-work"},{"title":"Continue work across hours and rounds","href":"/guides/work-that-spans-hours"},{"title":"Swap model providers without changing your code","href":"/guides/switching-model-providers"},{"title":"Let several agents work on one thing","href":"/guides/agents-that-work-together"},{"title":"Keep a crew honest","href":"/guides/keep-a-crew-honest"},{"title":"Run a fleet of ticket-driven agents in parallel","href":"/guides/parallel-ticket-fleet"},{"title":"Give an agent your tracker","href":"/guides/give-an-agent-your-tracker"},{"title":"Fix a GitHub issue and open the pull request","href":"/guides/fix-a-github-issue"},{"title":"Take over the machine the agent is working on","href":"/guides/take-over-the-agents-machine"},{"title":"Publish an app and let a visitor wake it","href":"/guides/wake-a-published-app"}]},{"group":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"},{"title":"Run a session inside a Temporal workflow","href":"/integrations/temporal"},{"title":"Give your agent framework a computer","href":"/integrations/agent-frameworks"},{"title":"Review pull requests in GitHub Actions","href":"/integrations/github-actions"},{"title":"Put an agent in a Slack thread","href":"/integrations/slack"},{"title":"Receive webhooks on Cloudflare Workers","href":"/integrations/cloudflare-workers"},{"title":"Meter usage into Stripe and Prometheus","href":"/integrations/usage-metering"},{"title":"Test a webhook handler without production","href":"/integrations/testing-webhook-handlers"}]},{"group":"Client libraries","pages":[{"title":"TypeScript client","href":"/typescript"},{"title":"Python client","href":"/python"}]},{"group":"When things go wrong","pages":[{"title":"Troubleshooting","href":"/troubleshooting"},{"title":"Errors","href":"/errors"},{"title":"Limits","href":"/limits"}]},{"group":"API reference","pages":[{"title":"Pagination","href":"/pagination"},{"title":"Objects","href":"/objects"}]},{"group":"About this API","pages":[{"title":"Changelog","href":"/changelog"},{"title":"Design decisions","href":"/design-decisions"},{"title":"The session loop","href":"/run-session"},{"title":"Build an integration","href":"/AGENTS"}]},{"group":"Endpoints","pages":[{"group":"API Reference","pages":[{"title":"Check the access token","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/health","href":"/api-reference/check-the-access-token"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions","href":"/api-reference/list-sessions"},{"title":"Create a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions","href":"/api-reference/create-a-session"},{"title":"Retrieve a session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}","href":"/api-reference/retrieve-a-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sessions/{session_id}","href":"/api-reference/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/sessions/{session_id}","href":"/api-reference/update-a-session"},{"title":"List turns","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/turns","href":"/api-reference/list-turns"},{"title":"Retrieve a turn","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/turns/{turn_id}","href":"/api-reference/retrieve-a-turn"},{"title":"Stream a session's events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/events","href":"/api-reference/stream-a-sessions-events"},{"title":"Send input to a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions/{session_id}/events","href":"/api-reference/send-input-to-a-session"},{"title":"Stream every session's events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/events","href":"/api-reference/stream-every-sessions-events"},{"title":"Retrieve sandbox usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/usage","href":"/api-reference/retrieve-sandbox-usage"},{"title":"List items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/items","href":"/api-reference/list-items"},{"title":"Fork a session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions/{session_id}/fork","href":"/api-reference/fork-a-session"},{"title":"Read a session's tools","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/tools","href":"/api-reference/read-a-sessions-tools"},{"title":"Replace a session's tools","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/sessions/{session_id}/tools","href":"/api-reference/replace-a-sessions-tools"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks","href":"/api-reference/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks","href":"/api-reference/create-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/{webhook_id}","href":"/api-reference/delete-a-webhook"},{"title":"List artifacts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/artifacts","href":"/api-reference/list-artifacts"},{"title":"Download all artifacts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/artifacts/archive","href":"/api-reference/download-all-artifacts"},{"title":"Retrieve an artifact","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/artifacts/{artifact_id}","href":"/api-reference/retrieve-an-artifact"},{"title":"Delete an artifact","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sessions/{session_id}/artifacts/{artifact_id}","href":"/api-reference/delete-an-artifact"},{"title":"Download an artifact","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/artifacts/{artifact_id}/content","href":"/api-reference/download-an-artifact"},{"title":"List workspace files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/files","href":"/api-reference/list-workspace-files"},{"title":"Write workspace files","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions/{session_id}/files","href":"/api-reference/write-workspace-files"},{"title":"Read a workspace file","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{session_id}/files/content","href":"/api-reference/read-a-workspace-file"},{"title":"Refresh the workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions/{session_id}/files/refresh","href":"/api-reference/refresh-the-workspace"},{"title":"List agents","description":"List the organization's agents.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents","href":"/api-reference/list-agents"},{"title":"Create or replace an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agents","href":"/api-reference/create-or-replace-an-agent"},{"title":"Retrieve an agent","description":"Retrieve one agent.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agents/{agent_id}","href":"/api-reference/retrieve-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/agents/{agent_id}","href":"/api-reference/delete-an-agent"},{"title":"List environment templates","deprecated":true,"version":null,"openapi":"/openapi.json get /v1/environment-templates","href":"/api-reference/list-environment-templates"},{"title":"Create an environment template","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/environment-templates","href":"/api-reference/create-an-environment-template"},{"title":"Retrieve an environment template","deprecated":true,"version":null,"openapi":"/openapi.json get /v1/environment-templates/{template_id}","href":"/api-reference/retrieve-an-environment-template"},{"title":"Delete an environment template","deprecated":true,"version":null,"openapi":"/openapi.json delete /v1/environment-templates/{template_id}","href":"/api-reference/delete-an-environment-template"},{"title":"List environment profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/environment-profiles","href":"/api-reference/list-environment-profiles"},{"title":"List model providers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/model-connectors","href":"/api-reference/list-model-providers"},{"title":"List model credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/model-credentials","href":"/api-reference/list-model-credentials"},{"title":"Connect a model credential","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/model-credentials","href":"/api-reference/connect-a-model-credential"},{"title":"Remove a model credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/model-credentials/{credential_id}","href":"/api-reference/remove-a-model-credential"},{"title":"Publish a preview","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions/{session_id}/preview","href":"/api-reference/publish-a-preview"},{"title":"Unpublish a preview","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/sessions/{session_id}/preview","href":"/api-reference/unpublish-a-preview"},{"title":"Retrieve the OpenAPI document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/openapi.json","href":"/api-reference/retrieve-the-openapi-document"}]}]}]},"basePath":"","title":"Create or replace an agent - Gobare Agent API Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}