The chat completions endpoint is the exception: it returns the OpenAI chat completion shape directly. Errors use error and code; resource API codes are generally uppercase, while Cloud authentication errors can use lowercase codes.
{ "ok": false, "error": "Agent not found", "code": "NOT_FOUND"}
POST /v1/chat/completions streams OpenAI-compatible data: chunks when stream is true. The Cloud-only POST /v1/tasks/{id}/execute endpoint streams runtime events. Mission execution returns JSON; observe the resulting tasks through task endpoints or the project event stream.
Only POST /v1/chat/completions is wire-compatible with the OpenAI chat completions format. Polpo-specific fields such as agent, loop, and sandbox are not represented by the standard OpenAI client API. The request model field can override the selected agent’s model for that call; it does not select the agent. Use @polpo-ai/sdk or raw HTTP when selecting an agent.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Polpo","colors":{"primary":"#3ecf8e","light":"#3ecf8e","dark":"#3ecf8e"},"logo":{"light":"https://mintcdn.com/lumeatechnologies/9eJEsrTjRTGUsX_D/logo/light.svg?fit=max\u0026auto=format\u0026n=9eJEsrTjRTGUsX_D\u0026q=85\u0026s=d9dd1d774bda40b0fdedbf67a90594f3","dark":"https://mintcdn.com/lumeatechnologies/9eJEsrTjRTGUsX_D/logo/dark.svg?fit=max\u0026auto=format\u0026n=9eJEsrTjRTGUsX_D\u0026q=85\u0026s=aa02ad781eaa095f66b6ce515507779c"},"favicon":"https://mintcdn.com/lumeatechnologies/7Fq_trt82LwuWEYI/favicon.svg?fit=max\u0026auto=format\u0026n=7Fq_trt82LwuWEYI\u0026q=85\u0026s=ddd7a3b55cf3b9c5fe82ef0841f4b4ef","appearance":{"default":"dark","strict":false},"navbar":{"links":[{"icon":"arrow-up-right","href":"https://polpo.sh","label":"Go to Dashboard"}]},"fonts":{"heading":{"family":"Plus Jakarta Sans","weight":700},"body":{"family":"Plus Jakarta Sans","weight":400}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lumeatechnologies","hasAudioNarration":false,"actualSubdomain":"lumeatechnologies","customDomains":["docs.polpo.sh"],"gitSource":{"type":"github","owner":"lumea-technologies","repo":"polpo-cloud","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad38e3caaec4b9bb26a73a3","collectionId":"86380acb-fe8a-45ab-b3a8-ba2833d2fe76","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad38e3caaec4b9bb26a73a3"},"entitlements":{},"buildId":"6ad38e3caaec4b9bb26a73a3","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":111},{"language":"default","tag":"Missions","count":28},{"language":"default","tag":"Documentation","count":27},{"language":"default","tag":"Agents","count":24},{"language":"default","tag":"Reference, CLI \u0026 SDKs","count":18},{"language":"default","tag":"Tasks","count":11},{"language":"default","tag":"Databases","count":10},{"language":"default","tag":"Skills","count":9},{"language":"default","tag":"Integrations","count":7},{"language":"default","tag":"Platform","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":".dark ::-webkit-scrollbar{width:8px;height:8px}.dark ::-webkit-scrollbar-track{background:0 0}.dark ::-webkit-scrollbar-thumb{background:rgba(255,255,255,.15);border-radius:4px}.dark ::-webkit-scrollbar-thumb:hover{background:rgba(255,255,255,.25)}.dark *{scrollbar-color:rgba(255,255,255,.15) transparent;scrollbar-width:thin}"}],"page":{"pagePath":"agent-api/overview","slug":"/agent-api/overview","pageMetadata":{"title":"Agent API Overview","description":"Authentication, base URL, and conventions for the Agent API","icon":"bolt","href":"/agent-api/overview"},"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: \"Authentication, base URL, and conventions for the Agent API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Agent API exposes the Polpo data plane through your Cloud project endpoint.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,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:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://{project}.polpo.cloud/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send a project API key as either a Bearer token or an `,_jsx(_components.code,{children:`x-api-key`}),` header. Keys start with `,_jsx(_components.code,{children:`sk_live_`}),` or `,_jsx(_components.code,{children:`sk_test_`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,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:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer sk_live_abc123`})]}),`\n`]})})}),`\n`,_jsx(Warning,{children:`Never expose a project API key in browser or mobile application code. Call Polpo from a backend or an authenticated server-side proxy.`}),`\n`,_jsx(Heading,{level:`2`,id:`response-format`,children:`Response format`}),`\n`,_jsx(_components.p,{children:`Most data-plane endpoints return an envelope:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"backend-dev\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"anthropic/claude-sonnet-4-5\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The chat completions endpoint is the exception: it returns the OpenAI chat completion shape directly. Errors use `,_jsx(_components.code,{children:`error`}),` and `,_jsx(_components.code,{children:`code`}),`; resource API codes are generally uppercase, while Cloud authentication errors can use lowercase codes.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"ok\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Agent not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"NOT_FOUND\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`streaming`,children:`Streaming`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`POST /v1/chat/completions`}),` streams OpenAI-compatible `,_jsx(_components.code,{children:`data:`}),` chunks when `,_jsx(_components.code,{children:`stream`}),` is `,_jsx(_components.code,{children:`true`}),`. The Cloud-only `,_jsx(_components.code,{children:`POST /v1/tasks/{id}/execute`}),` endpoint streams runtime events. Mission execution returns JSON; observe the resulting tasks through task endpoints or the project event stream.`]}),`\n`,_jsx(Heading,{level:`2`,id:`openai-compatibility`,children:`OpenAI compatibility`}),`\n`,_jsxs(_components.p,{children:[`Only `,_jsx(_components.code,{children:`POST /v1/chat/completions`}),` is wire-compatible with the OpenAI chat completions format. Polpo-specific fields such as `,_jsx(_components.code,{children:`agent`}),`, `,_jsx(_components.code,{children:`loop`}),`, and `,_jsx(_components.code,{children:`sandbox`}),` are not represented by the standard OpenAI client API. The request `,_jsx(_components.code,{children:`model`}),` field can override the selected agent’s model for that call; it does not select the agent. Use `,_jsx(_components.code,{children:`@polpo-ai/sdk`}),` or raw HTTP when selecting an agent.`]}),`\n`,_jsx(CodeBlock,{filename:``,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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://{project}.polpo.cloud/v1/chat/completions`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POLPO_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_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:` -H`}),_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:` -d`}),_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:` \"agent\": \"backend-dev\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"messages\": [{\"role\": \"user\", \"content\": \"Hello\"}],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"stream\": false`})}),`\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":"Agent API Overview","description":"Authentication, base URL, and conventions for the Agent API","icon":"bolt","href":"/agent-api/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Response format","slug":"response-format","depth":2,"children":[]},{"title":"Streaming","slug":"streaming","depth":2,"children":[]},{"title":"OpenAI compatibility","slug":"openai-compatibility","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"lumeatechnologies","siteName":"Polpo","title":"Agent API Overview - Polpo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-22T00:46:43.649Z","originalFileLocation":"agent-api/overview.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=\"dark\"}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=\"Authentication, base URL, and conventions for the Agent API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polpo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_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/lumeatechnologies/LbuZBmaaXgj7CAbI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Agent API Overview - Polpo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authentication, base URL, and conventions for the Agent API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polpo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.polpo.sh/agent-api/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lumeatechnologies.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Agent+API+Overview\u0026amp;description=Authentication%2C+base+URL%2C+and+conventions+for+the+Agent+API\u0026amp;theme=372a69af0d358c57b51a7064\u0026amp;signature=1da6a9e549fbedb94d5d5e51575db520ec97ec9e2c05263bbf69db6f8d0c446c\">\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=\"Agent API Overview - Polpo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authentication, base URL, and conventions for the Agent API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lumeatechnologies.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=Agent+API+Overview\u0026amp;description=Authentication%2C+base+URL%2C+and+conventions+for+the+Agent+API\u0026amp;theme=372a69af0d358c57b51a7064\u0026amp;signature=1da6a9e549fbedb94d5d5e51575db520ec97ec9e2c05263bbf69db6f8d0c446c\">\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/lumeatechnologies/LbuZBmaaXgj7CAbI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polpo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3ecf8e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.polpo.sh/agent-api/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/agent-api/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.polpo.sh/#organization\",\"name\":\"Polpo\",\"url\":\"https://docs.polpo.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lumeatechnologies/9eJEsrTjRTGUsX_D/logo/light.svg?fit=max\u0026auto=format\u0026n=9eJEsrTjRTGUsX_D\u0026q=85\u0026s=d9dd1d774bda40b0fdedbf67a90594f3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.polpo.sh#website\",\"name\":\"Polpo\",\"url\":\"https://docs.polpo.sh\",\"publisher\":{\"@id\":\"https://docs.polpo.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.polpo.sh/agent-api/overview#webpage\",\"url\":\"https://docs.polpo.sh/agent-api/overview\",\"name\":\"Agent API Overview\",\"description\":\"Authentication, base URL, and conventions for the Agent API\",\"dateModified\":\"2026-07-22T00:46:43.649Z\",\"isPartOf\":{\"@id\":\"https://docs.polpo.sh#website\"},\"breadcrumb\":{\"@id\":\"https://docs.polpo.sh/agent-api/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.polpo.sh/agent-api/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Polpo\",\"item\":\"https://docs.polpo.sh\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent API Overview\",\"item\":\"https://docs.polpo.sh/agent-api/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.polpo.sh/agent-api/overview#article\",\"headline\":\"Agent API Overview\",\"name\":\"Agent API Overview\",\"description\":\"Authentication, base URL, and conventions for the Agent API\",\"url\":\"https://docs.polpo.sh/agent-api/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.polpo.sh/agent-api/overview#webpage\"},\"dateModified\":\"2026-07-22T00:46:43.649Z\",\"publisher\":{\"@id\":\"https://docs.polpo.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.polpo.sh#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Polpo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Polpo","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"Reference, CLI \u0026 SDKs","pages":[{"title":"Reference, CLI \u0026 SDKs","href":"/developers/cli/overview"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Agent API Overview","icon":"bolt","href":"/agent-api/overview"},{"title":"Loops","description":"Project-level Agentic Loop API","icon":"workflow","href":"/agent-api/loops"}]},{"group":"Chat Completions","pages":[{"title":"Chat completions","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions/chat-completions"}]},{"group":"Databases","pages":[{"title":"List accessible databases","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/data","href":"/api-reference/databases/list-accessible-databases"},{"title":"Create a database and its tables","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/data","href":"/api-reference/databases/create-a-database-and-its-tables"},{"title":"Describe a database","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/data/{resource}","href":"/api-reference/databases/describe-a-database"},{"title":"Rename a database","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/data/{resource}","href":"/api-reference/databases/rename-a-database"},{"title":"Delete a database and its records","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/data/{resource}","href":"/api-reference/databases/delete-a-database-and-its-records"},{"title":"Apply an additive table schema migration","deprecated":null,"version":null,"openapi":"/agent-openapi.json put /api/v1/data/{resource}/schema","href":"/api-reference/databases/apply-an-additive-table-schema-migration"},{"title":"Run an atomic batch of structured record operations","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/data/{resource}/transactions","href":"/api-reference/databases/run-an-atomic-batch-of-structured-record-operations"},{"title":"Run a scoped SQL query or mutation","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/data/{resource}/query","href":"/api-reference/databases/run-a-scoped-sql-query-or-mutation"},{"title":"List applied SQL migrations (manage grant)","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/data/{resource}/migrations","href":"/api-reference/databases/list-applied-sql-migrations-manage-grant"},{"title":"Apply an atomic SQL migration (manage grant)","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/data/{resource}/migrations","href":"/api-reference/databases/apply-an-atomic-sql-migration-manage-grant"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents/{name}","href":"/api-reference/agents/get-agent"},{"title":"Add agent","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/agents","href":"/api-reference/agents/add-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/agents/{name}","href":"/api-reference/agents/update-agent"},{"title":"Remove agent","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/agents/{name}","href":"/api-reference/agents/remove-agent"},{"title":"List teams","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents/teams","href":"/api-reference/agents/list-teams"},{"title":"Get team info","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents/team","href":"/api-reference/agents/get-team-info"},{"title":"Add team","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/agents/teams","href":"/api-reference/agents/add-team"},{"title":"Rename team","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/agents/team","href":"/api-reference/agents/rename-team"},{"title":"Remove team","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/agents/teams/{name}","href":"/api-reference/agents/remove-team"},{"title":"List processes","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents/processes","href":"/api-reference/agents/list-processes"},{"title":"Get task activity","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/agents/processes/{taskId}/activity","href":"/api-reference/agents/get-task-activity"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/tasks/{taskId}","href":"/api-reference/tasks/get-task"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks","href":"/api-reference/tasks/create-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/tasks/{taskId}","href":"/api-reference/tasks/update-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/tasks/{taskId}","href":"/api-reference/tasks/delete-task"},{"title":"Bulk delete tasks","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/tasks","href":"/api-reference/tasks/bulk-delete-tasks"},{"title":"Retry task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks/{taskId}/retry","href":"/api-reference/tasks/retry-task"},{"title":"Kill task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks/{taskId}/kill","href":"/api-reference/tasks/kill-task"},{"title":"Re-run task assessment","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks/{taskId}/reassess","href":"/api-reference/tasks/re-run-task-assessment"},{"title":"Queue task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks/{taskId}/queue","href":"/api-reference/tasks/queue-task"},{"title":"Force fail task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/tasks/{taskId}/force-fail","href":"/api-reference/tasks/force-fail-task"}]},{"group":"Missions","pages":[{"title":"List missions","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/missions","href":"/api-reference/missions/list-missions"},{"title":"Get mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/missions/{missionId}","href":"/api-reference/missions/get-mission"},{"title":"List resumable missions","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/missions/resumable","href":"/api-reference/missions/list-resumable-missions"},{"title":"Create mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions","href":"/api-reference/missions/create-mission"},{"title":"Update mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}","href":"/api-reference/missions/update-mission"},{"title":"Delete mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}","href":"/api-reference/missions/delete-mission"},{"title":"Execute mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/execute","href":"/api-reference/missions/execute-mission"},{"title":"Resume mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/resume","href":"/api-reference/missions/resume-mission"},{"title":"Abort mission","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/abort","href":"/api-reference/missions/abort-mission"},{"title":"Add mission task","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/tasks","href":"/api-reference/missions/add-mission-task"},{"title":"Update mission task","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}/tasks/{taskTitle}","href":"/api-reference/missions/update-mission-task"},{"title":"Remove mission task","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}/tasks/{taskTitle}","href":"/api-reference/missions/remove-mission-task"},{"title":"Reorder mission tasks","deprecated":null,"version":null,"openapi":"/agent-openapi.json put /api/v1/missions/{missionId}/tasks/reorder","href":"/api-reference/missions/reorder-mission-tasks"},{"title":"Add mission checkpoint","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/checkpoints","href":"/api-reference/missions/add-mission-checkpoint"},{"title":"Update mission checkpoint","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}/checkpoints/{checkpointName}","href":"/api-reference/missions/update-mission-checkpoint"},{"title":"Remove mission checkpoint","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}/checkpoints/{checkpointName}","href":"/api-reference/missions/remove-mission-checkpoint"},{"title":"Resume checkpoint","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/checkpoints/{checkpointName}/resume","href":"/api-reference/missions/resume-checkpoint"},{"title":"List checkpoints","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/missions/checkpoints","href":"/api-reference/missions/list-checkpoints"},{"title":"Add mission delay","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/delays","href":"/api-reference/missions/add-mission-delay"},{"title":"Update mission delay","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}/delays/{delayName}","href":"/api-reference/missions/update-mission-delay"},{"title":"Remove mission delay","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}/delays/{delayName}","href":"/api-reference/missions/remove-mission-delay"},{"title":"List delays","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/missions/delays","href":"/api-reference/missions/list-delays"},{"title":"Add quality gate","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/quality-gates","href":"/api-reference/missions/add-quality-gate"},{"title":"Update quality gate","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}/quality-gates/{gateName}","href":"/api-reference/missions/update-quality-gate"},{"title":"Remove quality gate","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}/quality-gates/{gateName}","href":"/api-reference/missions/remove-quality-gate"},{"title":"Add team member","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/missions/{missionId}/team","href":"/api-reference/missions/add-team-member"},{"title":"Update team member","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/missions/{missionId}/team/{memberName}","href":"/api-reference/missions/update-team-member"},{"title":"Remove team member","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/missions/{missionId}/team/{memberName}","href":"/api-reference/missions/remove-team-member"}]},{"group":"Memory","pages":[{"title":"Get shared memory","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/memory","href":"/api-reference/memory/get-shared-memory"},{"title":"Update shared memory","deprecated":null,"version":null,"openapi":"/agent-openapi.json put /api/v1/memory","href":"/api-reference/memory/update-shared-memory"},{"title":"Get agent-specific memory","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/memory/agent/{agentName}","href":"/api-reference/memory/get-agent-specific-memory"},{"title":"Update agent-specific memory","deprecated":null,"version":null,"openapi":"/agent-openapi.json put /api/v1/memory/agent/{agentName}","href":"/api-reference/memory/update-agent-specific-memory"}]},{"group":"Files","pages":[{"title":"List file roots","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/files/roots","href":"/api-reference/files/list-file-roots"},{"title":"List directory contents","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/files/list","href":"/api-reference/files/list-directory-contents"},{"title":"Preview file","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/files/preview","href":"/api-reference/files/preview-file"}]},{"group":"Sessions","pages":[{"title":"List chat sessions","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/chat/sessions","href":"/api-reference/chat-sessions/list-chat-sessions"},{"title":"Get session messages","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/chat/sessions/{id}/messages","href":"/api-reference/chat-sessions/get-session-messages"},{"title":"Rename session","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/chat/sessions/{id}","href":"/api-reference/chat-sessions/rename-session"},{"title":"Delete session","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/chat/sessions/{id}","href":"/api-reference/chat-sessions/delete-session"}]},{"group":"Vault","pages":[{"title":"Save vault entry","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/vault/entries","href":"/api-reference/vault/save-vault-entry"},{"title":"List vault entries","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/vault/entries/{agent}","href":"/api-reference/vault/list-vault-entries"},{"title":"Update vault credentials","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/vault/entries/{agent}/{service}","href":"/api-reference/vault/update-vault-credentials"},{"title":"Remove vault entry","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/vault/entries/{agent}/{service}","href":"/api-reference/vault/remove-vault-entry"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/skills","href":"/api-reference/skills/list-skills"},{"title":"Get skills index","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/skills/index","href":"/api-reference/skills/get-skills-index"},{"title":"Get skill content","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/skills/{name}/content","href":"/api-reference/skills/get-skill-content"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/skills/create","href":"/api-reference/skills/create-skill"},{"title":"Install skills","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/skills/add","href":"/api-reference/skills/install-skills"},{"title":"Remove skill","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/skills/{name}","href":"/api-reference/skills/remove-skill"},{"title":"Assign skill","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/skills/{name}/assign","href":"/api-reference/skills/assign-skill"},{"title":"Unassign skill","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/skills/{name}/unassign","href":"/api-reference/skills/unassign-skill"},{"title":"Update skill index","deprecated":null,"version":null,"openapi":"/agent-openapi.json put /api/v1/skills/{name}/index","href":"/api-reference/skills/update-skill-index"}]},{"group":"Approvals","pages":[{"title":"List approval requests","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/approvals","href":"/api-reference/approvals/list-approval-requests"},{"title":"Get approval","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/approvals/{id}","href":"/api-reference/approvals/get-approval"},{"title":"Approve request","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/approvals/{id}/approve","href":"/api-reference/approvals/approve-request"},{"title":"Reject with feedback","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/approvals/{id}/reject","href":"/api-reference/approvals/reject-with-feedback"}]},{"group":"Schedules","pages":[{"title":"List schedules","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/schedules","href":"/api-reference/schedules/list-schedules"},{"title":"Create schedule","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/schedules","href":"/api-reference/schedules/create-schedule"},{"title":"Update schedule","deprecated":null,"version":null,"openapi":"/agent-openapi.json patch /api/v1/schedules/{missionId}","href":"/api-reference/schedules/update-schedule"},{"title":"Delete schedule","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/schedules/{missionId}","href":"/api-reference/schedules/delete-schedule"}]},{"group":"Playbooks","pages":[{"title":"List available playbooks","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/templates","href":"/api-reference/playbooks/list-available-playbooks"},{"title":"Get playbook details","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/templates/{name}","href":"/api-reference/playbooks/get-playbook-details"},{"title":"Save playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/templates","href":"/api-reference/playbooks/save-playbook"},{"title":"Run playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/templates/{name}/run","href":"/api-reference/playbooks/run-playbook"},{"title":"Delete playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/templates/{name}","href":"/api-reference/playbooks/delete-playbook"}]},{"group":"Logs","pages":[{"title":"List log sessions","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/logs","href":"/api-reference/logs/list-log-sessions"},{"title":"Get log entries","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/logs/{sessionId}","href":"/api-reference/logs/get-log-entries"}]},{"group":"Config","pages":[{"title":"Get config","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/config","href":"/api-reference/config/get-config"},{"title":"Reload config","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/config/reload","href":"/api-reference/config/reload-config"},{"title":"Get state","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/state","href":"/api-reference/state/get-state"},{"title":"Get orchestrator config","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/orchestrator-config","href":"/api-reference/state/get-orchestrator-config"}]},{"group":"Watchers","pages":[{"title":"List watchers","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/watchers","href":"/api-reference/watchers/list-watchers"},{"title":"Create watcher","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/watchers","href":"/api-reference/watchers/create-watcher"},{"title":"Delete watcher","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/watchers/{watcherId}","href":"/api-reference/watchers/delete-watcher"}]},{"group":"Templates","pages":[{"title":"List available playbooks","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/templates","href":"/api-reference/playbooks/list-available-playbooks"},{"title":"Get playbook details","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/templates/{name}","href":"/api-reference/playbooks/get-playbook-details"},{"title":"Save playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/templates","href":"/api-reference/playbooks/save-playbook"},{"title":"Run playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json post /api/v1/templates/{name}/run","href":"/api-reference/playbooks/run-playbook"},{"title":"Delete playbook","deprecated":null,"version":null,"openapi":"/agent-openapi.json delete /api/v1/templates/{name}","href":"/api-reference/playbooks/delete-playbook"}]},{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/agent-openapi.json get /api/v1/health","href":"/api-reference/health/health-check"}]}]}]},"title":"Agent API Overview - Polpo","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}
