{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}
Agents
Chat with an agent
Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.
POST
/
agents
/
{agentId}
/
chat
Chat with an agent
curl --request POST \ --url https://www.chatbase.co/api/v2/agents/{agentId}/chat \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "message": "Hello, how can you help me?", "conversationId": "<string>", "stream": true, "userId": "<string>"}'
import requests
url = "https://www.chatbase.co/api/v2/agents/{agentId}/chat"
payload = {
"message": "Hello, how can you help me?",
"conversationId": "<string>",
"stream": True,
"userId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: 'Hello, how can you help me?',
conversationId: '<string>',
stream: true,
userId: '<string>'
})
};
fetch('https://www.chatbase.co/api/v2/agents/{agentId}/chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}
Optional user ID to associate with a new conversation. Only applied when creating a new conversation (no conversationId). Once set, a conversation's userId is immutable — this field is ignored for existing conversations. Must contain only URL-safe characters (letters, digits, hyphens, underscores, dots).
Maximum string length: 128
Pattern: ^[a-zA-Z0-9._-]+$
Response
Successful response
Streaming response using the AI SDK UIMessage Stream protocol.
Each SSE event has an event: field with the type and a data: field with JSON content.
AI SDK events:
message-start — { type, messageId } — Start of a new message
start-step — { type } — Start of a processing step
finish-step — { type } — End of a processing step
finish — { type } — Stream complete
error — { type, errorText } — Error occurred
Chatbase metadata (emitted as message-metadata on the finish event):
The schema below describes the custom metadata attached to the finish event. Use conversationId for follow-up messages.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chatbase","colors":{"primary":"#18181b","light":"#f4f4f5","dark":"#18181b"},"logo":{"light":"https://mintcdn.com/chatbase/pJU9vM3D9oN_YQME/logo/light.svg?fit=max\u0026auto=format\u0026n=pJU9vM3D9oN_YQME\u0026q=85\u0026s=a45a73af7ac778cd0920dbb6ad1aaa93","dark":"https://mintcdn.com/chatbase/8k6_6eFSz4sj8EO0/logo/dark.svg?fit=max\u0026auto=format\u0026n=8k6_6eFSz4sj8EO0\u0026q=85\u0026s=c0c106d2f92f6a87f872a2be66706041","href":"https://chatbase.co"},"favicon":"https://mintcdn.com/chatbase/NsUPSmNqecm03uiz/favicon.ico?fit=max\u0026auto=format\u0026n=NsUPSmNqecm03uiz\u0026q=85\u0026s=b37388fc54cd76cfaf3efcb8ab4a4dc8","appearance":{},"navbar":{"links":[{"href":"https://chatbase.co/help","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.chatbase.co/dashboard"}},"footer":{"socials":{"x":"https://x.com/chatbase_co","linkedin":"https://linkedin.com/company/chatbase-co","youtube":"https://www.youtube.com/@chatbase_"}},"seo":{"metatags":{"canonical":"https://www.chatbase.co/docs"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatbase","hasAudioNarration":false,"actualSubdomain":"chatbase","customDomains":["chatbase.co"],"gitSource":{"type":"github","owner":"chatbase-co","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfc6a09b9230fa127ba040","collectionId":"f944d6dc-a02c-46cc-90d5-49ac75d4e0ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfc6a09b9230fa127ba040"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae07392cdcf99f97c30c970","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"User Guide","count":100},{"language":"default","tag":"API Reference","count":76},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"API v2","count":55},{"language":"default","tag":"Integrations","count":34},{"language":"default","tag":"Developer Guide","count":30},{"language":"default","tag":"AI Agent Management","count":30},{"language":"default","tag":"SDKs","count":26},{"language":"default","tag":"Help Desk","count":22},{"language":"default","tag":"API v1","count":21}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-dropdown-trigger{border-color:transparent!important;border-bottom-color:rgb(var(--gray-500)/.2)!important;border-radius:0!important;padding:.5rem .875rem .875rem 1rem!important}.nav-dropdown-trigger .nav-dropdown-item-icon{display:none!important}.nav-dropdown-trigger .nav-dropdown-item-text-container{padding-left:0!important}.nav-dropdown-trigger .nav-dropdown-item-title{font-weight:600!important}.nav-dropdown-item-title::after{display:inline-block;margin-left:.5rem;padding:.125rem .5rem;border-radius:.375rem;font-size:.7rem;font-weight:600;line-height:1.2;vertical-align:middle}:is(.nav-dropdown-trigger, .nav-dropdown-item):has([style*=\"/code.svg\"]) .nav-dropdown-item-title::after{content:\"Current\";color:rgb(22 163 74);background:rgb(22 163 74/.12)}:is(.nav-dropdown-trigger, .nav-dropdown-item):has([style*=\"/box-archive.svg\"]) .nav-dropdown-item-title::after{content:\"Deprecated\";color:rgb(217 119 6);background:rgb(217 119 6/.12)}"}],"page":{"pagePath":"api-reference/v2/agents/chat-with-an-agent","slug":"/api-reference/v2/agents/chat-with-an-agent","pageMetadata":{"title":"Chat with an agent","description":"Send a message to an agent and receive a response. Supports streaming responses when `stream: true` is set in the request body.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/chat","href":"/api-reference/v2/agents/chat-with-an-agent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Send a message to an agent and receive a response. Supports streaming responses when \", _jsx(_components.code, {\n children: \"stream: true\"\n }), \" is set in the request body.\"]\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":"Chat with an agent","description":"Send a message to an agent and receive a response. Supports streaming responses when `stream: true` is set in the request body.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/chat","href":"/api-reference/v2/agents/chat-with-an-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"chatWithAgent","x-mcp":{"tool":"chatbase_chat","scopes":["chatlogs:write"],"annotations":{"openWorld":true}},"tags":["Agents"],"summary":"Chat with an agent","description":"Send a message to an agent and receive a response. Supports streaming responses when `stream: true` is set in the request body.","security":["12751b67-8cc0-49ae-9d29-d882cbe1f69e"],"parameters":["d08a35c7-b47b-43c9-b64f-de3fa104b532"],"requestBody":"1ea66122-9539-4ddf-8a42-7a1a0f13e323","responses":{"200":"80812461-aae3-41c5-8345-5dd94e2a538d","400":"66d911bc-0f17-47d7-9344-4ad8363ea46d","401":"824c14db-bc82-4575-b6fa-fb7f6bc5344b","402":"4d7bb4cc-e0d3-42e7-a403-7823830240d6","403":"7471be43-da01-4d49-a996-f2c6b2c4fae0","404":"6fecc878-02de-43ea-beb2-7ff3c70a8257","429":"e324a02e-6229-478e-bbb6-31021bf92cdd","500":"a30e5e64-5cef-4507-8e64-782d1f546f63","503":"ee7a1df5-90fc-43ee-9a29-f060cb98fcc9"},"method":"post","type":"path","servers":["131cbcde-68c0-4c82-baf4-8793c7424f12"],"path":"/agents/{agentId}/chat","baseUrlOptions":["https://www.chatbase.co/api/v2"],"title":"Chat with an agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d08a35c7-b47b-43c9-b64f-de3fa104b532":{"schema":{"type":"string","minLength":1,"description":"The agent ID","example":"5QHA6VB-DIAbBhxwqxfdi","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The agent ID","name":"agentId","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","minLength":1,"description":"The user message to send to the agent. Omit to continue the conversation after submitting a tool result.","example":"Hello, how can you help me?","uniqueKey":"message","typeLabel":"string"},"conversationId":{"type":"string","description":"Optional conversation ID to continue an existing conversation. If omitted, a new conversation will be started.","uniqueKey":"conversationId","typeLabel":"string"},"stream":{"type":"boolean","default":true,"description":"Whether to stream the response as Server-Sent Events (SSE). Defaults to true.","uniqueKey":"stream","typeLabel":"boolean"},"userId":{"type":"string","maxLength":128,"pattern":"^[a-zA-Z0-9._-]+$","description":"Optional user ID to associate with a new conversation. Only applied when creating a new conversation (no conversationId). Once set, a conversation's userId is immutable — this field is ignored for existing conversations. Must contain only URL-safe characters (letters, digits, hyphens, underscores, dots).","uniqueKey":"userId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Hello, how can you help me?","conversationId":"\u003cstring>","stream":true,"userId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"80812461-aae3-41c5-8345-5dd94e2a538d":{"description":"Successful response","content":{"text/event-stream":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Unique ID of the assistant message","isRequired":true,"uniqueKey":"messageId","typeLabel":"string"},"userMessageId":{"type":"string","description":"The ID of the user message that triggered this response. For continuation responses, this is the last user message in the conversation.","isRequired":true,"uniqueKey":"userMessageId","typeLabel":"string"},"conversationId":{"type":"string","description":"The conversation ID. Use this for follow-up messages.","isRequired":true,"uniqueKey":"conversationId","typeLabel":"string"},"userId":{"oneOf":[{"type":"string","description":"The user ID associated with this conversation, or null if none","isRequired":true,"uniqueKey":"userId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user ID associated with this conversation, or null if none","isRequired":true,"uniqueKey":"userId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"userId","typeLabel":"string | null"},"usage":{"type":"object","properties":{"credits":{"type":"number","description":"Credits consumed by this request","example":2,"isRequired":true,"uniqueKey":"usage.credits","typeLabel":"number"}},"required":["credits"],"description":"Usage information for this request","isRequired":true,"uniqueKey":"usage","typeLabel":"object"}},"required":["messageId","userMessageId","conversationId","userId","usage"],"description":"Streaming response using the AI SDK UIMessage Stream protocol.\n\nEach SSE event has an `event:` field with the type and a `data:` field with JSON content.\n\n**AI SDK events:**\n- `message-start` — `{ type, messageId }` — Start of a new message\n- `text-start` — `{ type, id }` — Start of a text block\n- `text-delta` — `{ type, id, delta }` — Incremental text chunk\n- `text-end` — `{ type, id }` — End of a text block\n- `tool-input-start` — `{ type, toolCallId, toolName }` — Start of tool call input\n- `tool-input-delta` — `{ type, toolCallId, inputTextDelta }` — Incremental tool input\n- `tool-input-available` — `{ type, toolCallId, toolName, input }` — Complete tool input\n- `tool-output-available` — `{ type, toolCallId, output }` — Tool execution result\n- `start-step` — `{ type }` — Start of a processing step\n- `finish-step` — `{ type }` — End of a processing step\n- `finish` — `{ type }` — Stream complete\n- `error` — `{ type, errorText }` — Error occurred\n\n**Chatbase metadata (emitted as `message-metadata` on the finish event):**\nThe schema below describes the custom metadata attached to the `finish` event. Use `conversationId` for follow-up messages.\n\nStream terminates with `data: [DONE]`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"messageId":"\u003cstring>","userMessageId":"\u003cstring>","conversationId":"\u003cstring>","userId":"\u003cstring>","usage":{"credits":2}}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique message ID","example":"msg_abc123","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"role":{"type":"string","enum":["assistant"],"description":"The message role (always \"assistant\" for responses)","isRequired":true,"uniqueKey":"data.role","typeLabel":"enum\u003cstring>"},"parts":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","enum":["text"],"isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"data.parts.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","toolCallId","toolName"],"properties":{"type":{"type":"string","enum":["tool-call"],"isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"toolCallId":{"type":"string","isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.1.toolCallId","typeLabel":"string"},"toolName":{"type":"string","isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.1.toolName","typeLabel":"string"},"input":{"oneOf":[{}],"uniqueKey":"data.parts.items.[INDEX].oneOf.1.input","typeLabel":"any"}},"uniqueKey":"data.parts.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["type","toolCallId","toolName"],"properties":{"type":{"type":"string","enum":["tool-result"],"isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"toolCallId":{"type":"string","isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.2.toolCallId","typeLabel":"string"},"toolName":{"type":"string","isRequired":true,"uniqueKey":"data.parts.items.[INDEX].oneOf.2.toolName","typeLabel":"string"},"output":{"oneOf":[{}],"uniqueKey":"data.parts.items.[INDEX].oneOf.2.output","typeLabel":"any"}},"uniqueKey":"data.parts.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"data.parts.items.[INDEX]","typeLabel":"object"},"description":"Message content parts. Can include text, tool calls, and tool results. Use this for full detail including tool interactions.","isRequired":true,"uniqueKey":"data.parts","typeLabel":"object[]"},"metadata":{"type":"object","properties":{"userMessageId":{"type":"string","description":"The ID of the user message that triggered this response. For continuation responses, this is the last user message in the conversation.","isRequired":true,"uniqueKey":"data.metadata.userMessageId","typeLabel":"string"},"conversationId":{"type":"string","description":"The conversation ID. Use this for follow-up messages to continue the conversation.","isRequired":true,"uniqueKey":"data.metadata.conversationId","typeLabel":"string"},"userId":{"oneOf":[{"type":"string","description":"The user ID associated with this conversation, or null if none","isRequired":true,"uniqueKey":"data.metadata.userId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user ID associated with this conversation, or null if none","isRequired":true,"uniqueKey":"data.metadata.userId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metadata.userId","typeLabel":"string | null"},"finishReason":{"type":"string","enum":["stop","error","tool-calls"],"description":"Why the model stopped generating. \"stop\" means normal completion, \"error\" means an error occurred, \"tool-calls\" means the model invoked a client-side action — submit the tool result and continue the conversation.","isRequired":true,"uniqueKey":"data.metadata.finishReason","typeLabel":"enum\u003cstring>"},"usage":{"type":"object","properties":{"credits":{"type":"number","description":"Credits consumed by this request","example":2,"isRequired":true,"uniqueKey":"data.metadata.usage.credits","typeLabel":"number"}},"required":["credits"],"description":"Usage information for this request","isRequired":true,"uniqueKey":"data.metadata.usage","typeLabel":"object"}},"required":["userMessageId","conversationId","userId","finishReason","usage"],"description":"Response metadata including conversation tracking","isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object"}},"required":["id","role","parts","metadata"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"msg_abc123","role":"assistant","parts":[{"type":"text","text":"\u003cstring>"}],"metadata":{"userMessageId":"\u003cstring>","conversationId":"\u003cstring>","userId":"\u003cstring>","finishReason":"stop","usage":{"credits":2}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"66d911bc-0f17-47d7-9344-4ad8363ea46d":{"description":"The request body failed schema validation. Inspect the `details` object in the error response for field-level errors.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"VALIDATION_INVALID_BODY","message":"Invalid request"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_INVALID_BODY","message":"Invalid request"}}}},"exampleType":"examples"}},"exampleType":"examples"},"824c14db-bc82-4575-b6fa-fb7f6bc5344b":{"description":"No Authorization header present. Provide a valid API key as a Bearer token in the Authorization header: `Authorization: Bearer \u003capi-key>`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"AUTH_MISSING_API_KEY","message":"Authentication required"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AUTH_MISSING_API_KEY","message":"Authentication required"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4d7bb4cc-e0d3-42e7-a403-7823830240d6":{"description":"The account's message credit balance is zero. Upgrade the plan or wait for credits to reset at the next billing cycle.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"CHAT_CREDITS_EXHAUSTED","message":"Message limit reached"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"CHAT_CREDITS_EXHAUSTED","message":"Message limit reached"}}}},"exampleType":"examples"}},"exampleType":"examples"},"7471be43-da01-4d49-a996-f2c6b2c4fae0":{"description":"Your current plan does not include API access. Upgrade to the Basic plan or higher to use the API.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SUBSCRIPTION_API_RESTRICTED_PLAN","message":"A Basic plan or higher is required to access the API"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SUBSCRIPTION_API_RESTRICTED_PLAN","message":"A Basic plan or higher is required to access the API"}}}},"exampleType":"examples"}},"exampleType":"examples"},"6fecc878-02de-43ea-beb2-7ff3c70a8257":{"description":"No agent matches the provided `agentId`, or it does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"AGENT_NOT_FOUND","message":"Agent not found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AGENT_NOT_FOUND","message":"Agent not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"e324a02e-6229-478e-bbb6-31021bf92cdd":{"description":"Rate limit exceeded. Check the `X-RateLimit-Reset` response header for the Unix epoch seconds when the limit resets.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_TOO_MANY_REQUESTS","message":"Too many requests, please try again later"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_TOO_MANY_REQUESTS","message":"Too many requests, please try again later"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a30e5e64-5cef-4507-8e64-782d1f546f63":{"description":"An unhandled server error occurred. If the issue persists, contact support with the `x-request-id` response header value for debugging.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"Something went wrong, please try again"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"Something went wrong, please try again"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ee7a1df5-90fc-43ee-9a29-f060cb98fcc9":{"description":"Chatbase is undergoing scheduled maintenance and the API is temporarily rejecting requests. This is transient; retry after a short delay. Requests are rejected before any data is read or written, so no partial changes are applied.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNDER_MAINTENANCE","message":"The API is temporarily unavailable for scheduled maintenance, please try again later"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNDER_MAINTENANCE","message":"The API is temporarily unavailable for scheduled maintenance, please try again later"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"12751b67-8cc0-49ae-9d29-d882cbe1f69e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key from your account settings","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"131cbcde-68c0-4c82-baf4-8793c7424f12":{"url":"https://www.chatbase.co/api/v2","description":"Chatbase API v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key from your account settings","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from your account settings","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-v2-openapi.json"},"subdomain":"chatbase","siteName":"Chatbase","title":"Chat with an agent - Chatbase","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T09:49:25.433Z","originalFileLocation":"api-reference/v2/agents/chat-with-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=\"Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chatbase\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_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=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Chat with an agent - Chatbase\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chatbase\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatbase.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Chat+with+an+agent\u0026amp;description=Send+a+message+to+an+agent+and+receive+a+response.+Supports+streaming+responses+when+%60stream%3A+true%60+is+set+in+the+request+body.\u0026amp;theme=8967705c05e833213354143b\u0026amp;signature=41e7a8239663c00103a3da83fedbbc983016ec8d697a8403242e2d21b4ffd7cc\">\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=\"Chat with an agent - Chatbase\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatbase.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Chat+with+an+agent\u0026amp;description=Send+a+message+to+an+agent+and+receive+a+response.+Supports+streaming+responses+when+%60stream%3A+true%60+is+set+in+the+request+body.\u0026amp;theme=8967705c05e833213354143b\u0026amp;signature=41e7a8239663c00103a3da83fedbbc983016ec8d697a8403242e2d21b4ffd7cc\">\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=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chatbase\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18181b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v2/agents/chat-with-an-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.chatbase.co/#organization\",\"name\":\"Chatbase\",\"url\":\"https://www.chatbase.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatbase/pJU9vM3D9oN_YQME/logo/light.svg?fit=max\u0026auto=format\u0026n=pJU9vM3D9oN_YQME\u0026q=85\u0026s=a45a73af7ac778cd0920dbb6ad1aaa93\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.chatbase.co/docs#website\",\"name\":\"Chatbase\",\"url\":\"https://www.chatbase.co/docs\",\"publisher\":{\"@id\":\"https://www.chatbase.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent#webpage\",\"url\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent\",\"name\":\"Chat with an agent\",\"description\":\"Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.\",\"dateModified\":\"2026-10-27T09:49:25.433Z\",\"isPartOf\":{\"@id\":\"https://www.chatbase.co/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Chat with an agent\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent#apireference\",\"headline\":\"Chat with an agent\",\"name\":\"Chat with an agent\",\"description\":\"Send a message to an agent and receive a response. Supports streaming responses when stream: true is set in the request body.\",\"url\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent\",\"mainEntityOfPage\":{\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/chat-with-an-agent#webpage\"},\"dateModified\":\"2026-10-27T09:49:25.433Z\",\"publisher\":{\"@id\":\"https://www.chatbase.co/#organization\"},\"isPartOf\":{\"@id\":\"https://www.chatbase.co/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chatbase\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chatbase","nav":{"global":null,"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user-guides/quick-start/introduction"}]},{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-guides/overview"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"API v2","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"API v2 Overview","sidebarTitle":"Overview","href":"/api-reference/v2/overview"},{"title":"Authentication","href":"/api-reference/v2/authentication"},{"title":"Streaming","href":"/api-reference/v2/streaming"},{"title":"Error Handling","href":"/api-reference/v2/error-handling"},{"title":"Pagination","href":"/api-reference/v2/pagination"}]},{"group":"Guides","pages":[{"title":"Agents","href":"/api-reference/v2/agents"},{"title":"User Conversations","href":"/api-reference/v2/user-conversations"},{"title":"Conversation Search","href":"/api-reference/v2/conversation-search"},{"title":"Sources","href":"/api-reference/v2/sources"},{"title":"Helpdesk","href":"/api-reference/v2/helpdesk"},{"title":"WhatsApp","href":"/api-reference/v2/whatsapp"},{"title":"Voice Sessions","href":"/api-reference/v2/voice"},{"title":"Client Actions","href":"/api-reference/v2/client-actions"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /health","href":"/api-reference/v2/health/health-check"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents","href":"/api-reference/v2/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents","href":"/api-reference/v2/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}","href":"/api-reference/v2/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}","href":"/api-reference/v2/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json delete /agents/{agentId}","href":"/api-reference/v2/agents/delete-agent"},{"title":"Update agent styles","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/styles","href":"/api-reference/v2/agents/update-agent-styles"},{"title":"Toggle auto-retrain","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/auto-retrain","href":"/api-reference/v2/agents/toggle-auto-retrain"},{"title":"Clone agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/clone","href":"/api-reference/v2/agents/clone-agent"},{"title":"Train agent (deprecated)","description":"**Deprecated.** Sources train as soon as they are created, updated or deleted, so changes take effect immediately and there is nothing to trigger. The call does nothing and always succeeds. Poll `GET /agents/{agentId}/sources/{sourceId}` and read `status` to follow a source, or `GET /agents/{agentId}` for the agent-level `status`.","deprecated":true,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/train","href":"/api-reference/v2/agents/train-agent-deprecated"},{"title":"Chat with an agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/chat","href":"/api-reference/v2/agents/chat-with-an-agent"},{"title":"Retry a message","description":"Retry generating an assistant response for a given message. Truncates the conversation at the target message, then re-sends the preceding user message through the chat service.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/conversations/{conversationId}/retry","href":"/api-reference/v2/agents/retry-a-message"},{"title":"Start a voice session","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/voice/sessions","href":"/api-reference/v2/agents/start-a-voice-session"},{"title":"Submit a tool result","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/conversations/{conversationId}/tool-result","href":"/api-reference/v2/agents/submit-a-tool-result"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations","href":"/api-reference/v2/conversations/list-conversations"},{"title":"Export conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/export","href":"/api-reference/v2/conversations/export-conversations"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/search","href":"/api-reference/v2/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/{conversationId}","href":"/api-reference/v2/conversations/get-a-conversation"},{"title":"Update conversation status","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/conversations/{conversationId}","href":"/api-reference/v2/conversations/update-conversation-status"},{"title":"List conversation messages","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/{conversationId}/messages","href":"/api-reference/v2/conversations/list-conversation-messages"},{"title":"List conversations for a user","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/users/{userId}/conversations","href":"/api-reference/v2/conversations/list-conversations-for-a-user"},{"title":"Update message feedback","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/conversations/{conversationId}/messages/{messageId}/feedback","href":"/api-reference/v2/conversations/update-message-feedback"}]},{"group":"Sources","pages":[{"title":"Get sources summary","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources/summary","href":"/api-reference/v2/sources/get-sources-summary"},{"title":"List sources","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources","href":"/api-reference/v2/sources/list-sources"},{"title":"Create source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/sources","href":"/api-reference/v2/sources/create-source"},{"title":"Get source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/get-source"},{"title":"Update source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/update-source"},{"title":"Delete source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json delete /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/delete-source"},{"title":"Restore source (deprecated)","deprecated":true,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/sources/{sourceId}/restore","href":"/api-reference/v2/sources/restore-source-deprecated"},{"title":"Create file source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /api/v2/agents/{agentId}/sources","href":"/api-reference/v2/sources/create-file-source"},{"title":"Update file source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /api/v2/agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/update-file-source"}]},{"group":"WhatsApp","pages":[{"title":"List WhatsApp templates","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/whatsapp/templates","href":"/api-reference/v2/whatsapp/list-whatsapp-templates"},{"title":"Send a WhatsApp template message","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/whatsapp/messages/template","href":"/api-reference/v2/whatsapp/send-a-whatsapp-template-message"}]},{"group":"Helpdesk","pages":[{"title":"List ticket statuses","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/ticket-statuses","href":"/api-reference/v2/helpdesk/list-ticket-statuses"},{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/teams","href":"/api-reference/v2/helpdesk/list-teams"},{"title":"List tickets","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets","href":"/api-reference/v2/helpdesk/list-tickets"},{"title":"Create a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets","href":"/api-reference/v2/helpdesk/create-a-ticket"},{"title":"Search tickets","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets/search","href":"/api-reference/v2/helpdesk/search-tickets"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets/{ticketNumber}","href":"/api-reference/v2/helpdesk/get-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/helpdesk/tickets/{ticketNumber}","href":"/api-reference/v2/helpdesk/update-a-ticket"},{"title":"List ticket messages","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets/{ticketNumber}/messages","href":"/api-reference/v2/helpdesk/list-ticket-messages"},{"title":"Add a message to a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets/{ticketNumber}/messages","href":"/api-reference/v2/helpdesk/add-a-message-to-a-ticket"}]}]}]},{"dropdown":"API v1","icon":"box-archive","groups":[{"group":"Getting Started","pages":[{"title":"API v1 Overview","sidebarTitle":"Overview","href":"/api-reference/v1/overview"}]},{"group":"Endpoints","pages":[{"group":"Chat","pages":[{"title":"Chat with a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat","href":"/api-reference/v1/chat/chat-with-a-chatbot"}]},{"group":"Chatbots","pages":[{"title":"Create a new chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /create-chatbot","href":"/api-reference/v1/chatbots/create-a-new-chatbot"},{"title":"Get all chatbots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-chatbots","href":"/api-reference/v1/chatbots/get-all-chatbots"},{"title":"Delete a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot","href":"/api-reference/v1/chatbots/delete-a-chatbot"},{"title":"Update a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /update-chatbot-data","href":"/api-reference/v1/chatbots/update-a-chatbot"},{"title":"Update chatbot settings","deprecated":null,"version":null,"openapi":"/openapi.yaml post /update-chatbot-settings","href":"/api-reference/v1/chatbots/update-chatbot-settings"}]},{"group":"Conversations","pages":[{"title":"Get conversations for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-conversations","href":"/api-reference/v1/conversations/get-conversations-for-a-chatbot"}]},{"group":"Leads","pages":[{"title":"Get leads for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-leads","href":"/api-reference/v1/leads/get-leads-for-a-chatbot"}]},{"group":"Assets","pages":[{"title":"Upload chatbot icon","deprecated":null,"version":null,"openapi":"/openapi.yaml post /upload-chatbot-icon","href":"/api-reference/v1/assets/upload-chatbot-icon"},{"title":"Upload chatbot profile picture","deprecated":null,"version":null,"openapi":"/openapi.yaml post /upload-chatbot-profile-picture","href":"/api-reference/v1/assets/upload-chatbot-profile-picture"},{"title":"Delete chatbot icon","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot-icon","href":"/api-reference/v1/assets/delete-chatbot-icon"},{"title":"Delete chatbot profile picture","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot-profile-picture","href":"/api-reference/v1/assets/delete-chatbot-profile-picture"}]},{"group":"Contacts","pages":[{"title":"Get contacts for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/contacts","href":"/api-reference/v1/contacts/get-contacts-for-a-chatbot"},{"title":"Create contacts for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chatbots/{chatbotId}/contacts","href":"/api-reference/v1/contacts/create-contacts-for-a-chatbot"},{"title":"Get a specific contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/get-a-specific-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/update-a-contact"},{"title":"Get custom attributes schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/custom-attributes","href":"/api-reference/v1/contacts/get-custom-attributes-schema"},{"title":"Create custom attribute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chatbots/{chatbotId}/custom-attributes","href":"/api-reference/v1/contacts/create-custom-attribute"},{"title":"Update custom attribute","deprecated":null,"version":null,"openapi":"/openapi.yaml put /chatbots/{chatbotId}/custom-attributes/{name}","href":"/api-reference/v1/contacts/update-custom-attribute"}]}]}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Help \u0026 Support","pages":[{"title":"Help \u0026 Support","href":"/faq/faq"}]}]},"title":"Chat with an agent - Chatbase","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}