Chat Or Question And Answer Using Retreival Agent

post/teams/{team_id}/bots/{bot_id}/chat-agent

Request

  • Base URL: https://api.docsbot.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/chat-agent
  • Auth: none declared

Path parameters

team_idstring required
bot_idstring required

Request body

questionstring nullable
historyunknown
format'markdown' | 'text' | 'html' nullable
full_sourceboolean nullable
metadataobject nullable
testingboolean nullable
context_itemsinteger
conversationIdstring required

Unique identifier for the conversation, pass a new UUID to start a new conversation

channel'chat' | 'voice' | 'phone' | 'slack' | 'helpscout' | 'messenger' | 'whatsapp' | 'telegram' nullable

Internal conversation channel persisted on the conversation object.

streamboolean

Whether to stream the response with SSE or return it all at once

human_escalationboolean

Whether to enable the human escalation detection tool

calendlyboolean

Whether to enable the Calendly booking tool

calcomboolean

Whether to enable the Cal.com booking tool

tidycalboolean

Whether to enable the TidyCal booking tool

custom_buttonsboolean

Whether to enable custom button tools built from bot.tools.customButtons

followup_ratingboolean

Whether to enable the follow-up rating tool

document_retrieverboolean

Whether to enable the document retrieval tool for factual answers

openapiboolean

Ignore this field, not yet implemented

image_urlsstring[] nullable

List of image URLs to include as context for this message

modelstring nullable

Any valid OpenAI model string supported by DocsBot.

default_languagestring nullable

The default language to use, if the language of the conversation is unclear. Use the locale code like 'en' or 'en-US'. Defaults to bot language.

reasoning_effort'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' nullable

Reasoning depth for the response. Requires authentication and the Personal plan or above to override default. 'none' (GPT-5.1) and 'minimal' (GPT-5) use the least reasoning, 'low' is light, 'medium' balanced, 'high' deeper, 'xhigh' deeper still (GPT-5.4/5.6/6), and 'max' deepest (GPT-5.6 Sol or GPT-6 Astra). Defaults: GPT-6 Luna → 'medium', GPT-6 Sol/Astra → 'low', GPT-5.6 Luna → 'low', other GPT-5.6 → 'none', GPT-5.4 nano → 'medium', GPT-5.4 mini → 'low', other versioned GPT-5.x → 'none', GPT-5 → 'minimal', other reasoning models → 'low', non-reasoning models → ignored.

search_limitinteger nullable

Maximum number of times the search_documentation tool can be called. Requires authentication to override default. Minimum: 1, Maximum: 4. Defaults to bot's searchDocumentationLimit or 2 (default is 2 for latency and token cost reasons).

Example request

{
  "metadata": {
    "customVar": "value",
    "email": "john@doe.com",
    "name": "John Doe",
    "referrer": "https://somesite.com/page/"
  }
}

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.