The DocsBot AI connector lets your AI agent act in each user's DocsBot AI account. Each user connects their own DocsBot AI access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 54 tools.
- Tools
- 54
- What they doRead · write · destructive
- 23 · 23 · 823 read23 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the DocsBot AI connection
In AgentKit > Connections, create a DocsBot AI connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'docsbot'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize DocsBot AI:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'docsbot_teams_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "docsbot"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize DocsBot AI:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="docsbot_teams_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their DocsBot AI credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooldocsbot_bot_getGet one DocsBot bot by ID.Read-onlyGet Bot
Get one DocsBot bot by ID. Returns its name, description, privacy, model, embedding model, custom prompt, language, widget settings, tools, retriever tags, status and usage counts. Use List Bots to find bot IDs.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_bot_reports_getGet a bot's monthly report and the list of months that have reports.Read-onlyGet Bot Reports
Get a bot's monthly report and the list of months that have reports. Returns the available report months and the report data for the selected month. Use Get Bot Statistics for custom date ranges.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
monthstring- Report month as YYYY-MM. Defaults to the latest report. Example: 2026-10.
docsbot_bot_stats_getGet aggregated usage statistics for a bot over a number of days or a date range.Read-onlyGet Bot Statistics
Get aggregated usage statistics for a bot over a number of days or a date range. Returns question, rating, escalation, answer-rate, sentiment and topic counts with chart labels. Use Get Bot Reports for monthly reports.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
end_datestring- End of the range (ISO 8601 or YYYY-MM-DD). Give with start_date. Ranges are capped at 365 days. Example: 2026-10-31.
start_datestring- Start of the range (ISO 8601 or YYYY-MM-DD). Give with end_date. Example: 2026-10-01.
time_deltainteger- Days to analyze, 0 to 365. Defaults to 30. Ignored when start_date and end_date are given. Example: 30.
docsbot_bots_listList the bots in a DocsBot team, with optional text search, privacy filter, sorting and paging.Read-onlyList Bots
List the bots in a DocsBot team, with optional text search, privacy filter, sorting and paging. Returns bots with id, name, description, privacy, model, status and usage counts; any paging option returns a paginated envelope with totalCount and totalPages. Use Get Bot for one bot's full settings.
Inputs
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
orderstring- Sort direction: asc or desc. Defaults to asc for name and desc otherwise. Example: desc.one of
ascdesc pageinteger- Zero-based page number. Defaults to 0. Example: 1.
page_sizeinteger- Bots per page, 1 to 100. Defaults to 100 when paging. Example: 25.
privacystring- Only bots with this privacy: public or private. Example: public.one of
publicprivate qstring- Case-insensitive text matched against bot name and description. Example: support.
sortstring- Sort order field: name, newest, ai-credits or conversations. Defaults to newest. Example: conversations.one of
namenewestai-creditsconversations viewstring- full returns all bot settings; summary returns compact listing data. Example: summary.one of
fullsummary
docsbot_conversation_getGet one conversation with its full message history.Read-onlyGet Conversation
Get one conversation with its full message history. Returns the conversation fields, history messages (Human and AI, with types and question IDs) and any ticket subject and content. Use List Conversations to find conversation IDs.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_conversations_listList a bot's Chat Agent conversations, newest first, without message history.Read-onlyList Conversations
List a bot's Chat Agent conversations, newest first, without message history. Returns conversations with id, title, summary, sentiment, channel, resolved and escalated status, metadata, and pagination. Use Get Conversation for the full message history.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
pageinteger- Zero-based page number. Defaults to 0. Example: 1.
per_pageinteger- Conversations per page. Defaults to 25. Example: 25.
docsbot_document_fetchFetch the full reconstructed text of one indexed document.Read-onlyFetch Document
Fetch the full reconstructed text of one indexed document. Returns the document content. Use Semantic Search first to get the file ID.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
file_idstringrequired- File ID of the document, from a Semantic Search result. Example: doc_7f3a2b1c.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_leads_exportExport a bot's leads in a date range as a CSV file.Read-onlyExport Leads
Export a bot's leads in a date range as a CSV file. Returns a signed URL to download the CSV. Use List Leads to read leads as JSON. Needs owner, admin or editor access.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
end_datestringrequired- End of the created date range (ISO date-time). Example: 2026-10-31T23:59:59.999Z.
start_datestringrequired- Start of the created date range (ISO date-time). Example: 2026-10-01T00:00:00.000Z.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_leads_listList the leads a bot has captured, with optional date filters.Read-onlyList Leads
List the leads a bot has captured, with optional date filters. Returns leads with id (the conversation ID), metadata such as name and email, and timestamps. Use Export Leads for a CSV file.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
end_datestring- Only leads created before this date or ISO date-time. Example: 2026-10-31T23:59:59.999Z.
pageinteger- Zero-based page number. Defaults to 0. Example: 1.
per_pageinteger- Leads per page. Defaults to 50. Example: 50.
start_datestring- Only leads created after this date or ISO date-time. Example: 2026-10-01T00:00:00.000Z.
docsbot_questions_listList the question history of a bot, filterable by rating, escalation, answerability, IP hash and date.Read-onlyList Questions
List the question history of a bot, filterable by rating, escalation, answerability, IP hash and date. Returns questions with id, question, answer, sources, rating, escalation flag and timestamps. Use List Conversations for whole Chat Agent threads.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
could_answerboolean- Only questions the bot could (true) or could not (false) answer. Example: false.
end_datestring- Only questions before this date or ISO date-time. Example: 2026-10-31.
escalatedboolean- Only escalated (true) or non-escalated (false) questions. Example: true.
ipstring- Only questions from this SHA-256 IP hash. Example: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08.
pageinteger- Zero-based page number. Defaults to 0. Example: 1.
per_pageinteger- Questions per page. Defaults to 50. Example: 50.
ratinginteger- Only questions with this rating: -1 (down), 0 (neutral) or 1 (up). Example: 1.one of
-101 start_datestring- Only questions after this date or ISO date-time. Example: 2026-10-01.
docsbot_research_job_getGet a deep research job's status and result.Read-onlyGet Research Job
Get a deep research job's status and result. Returns its status, any clarifying questions and, when completed, the research response. Use List Research Jobs to find job IDs.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
job_idstringrequired- Deep research job ID, returned by Start Deep Research or List Research Jobs. Example: rj_8Kx2mQ4pLz.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_research_jobs_listList a bot's deep research jobs.Read-onlyList Research Jobs
List a bot's deep research jobs. Returns jobs with job ID, status, title, question and timestamps, and pagination. Use Get Research Job for one job's result.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
pageinteger- Zero-based page number. Defaults to 0. Example: 1.
per_pageinteger- Jobs per page. Defaults to 25. Example: 25.
docsbot_semantic_searchSearch a bot's indexed content without generating an answer.Read-onlySemantic Search
Search a bot's indexed content without generating an answer. Returns matching chunks with title, url, page and content. Use Chat with Agent for an AI answer. Use Fetch Document for a whole file.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
querystringrequired- Search text. Example: reset password.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
alphanumber- Hybrid weighting: 0 is pure keyword, 1 is pure semantic. Defaults to 0.5. Example: 0.5.
include_untaggedboolean- Also return untagged chunks when tags is set. Defaults to true. Example: true.
source_idstring- Only search this source. Example: qGDSDhbdxtqmifTZQrYs.
tagsarray- Only return chunks with these source tag keys. Example: ["billing"].
top_kinteger- Number of results. Defaults to 5. Example: 5.
use_glossaryboolean- Apply the bot's glossary to the query. Example: false.
docsbot_source_download_getGet a signed download URL for a single-file source's uploaded file.Read-onlyGet Source Download URL
Get a signed download URL for a single-file source's uploaded file. Returns a signed url and a suggested filename. Use Get Source File Download URL for one file of a multi-file source.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_source_file_download_getGet a signed download URL for one file in a multi-file document source.Read-onlyGet Source File Download URL
Get a signed download URL for one file in a multi-file document source. Returns a signed url and a suggested filename. Use Get Source to read the file paths.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
file_namestringrequired- Relative path of the file from the source's files list (p), or its base name. Example: guides/setup.pdf.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_source_getGet one training source by ID.Read-onlyGet Source
Get one training source by ID. Returns its type, title, url, status, page and chunk counts, tags, schedule, indexed URLs, FAQs and warnings. Use List Sources to find source IDs.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_source_tag_counts_getCount a bot's sources per configured tag key, plus untagged sources.Read-onlyGet Source Tag Counts
Count a bot's sources per configured tag key, plus untagged sources. Returns a count for each tag key and an untagged count. Use List Sources with tags to see the sources. Needs retriever tags (Standard plan and above).
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_sources_listList a bot's training sources, optionally filtered by tag.Read-onlyList Sources
List a bot's training sources, optionally filtered by tag. Returns sources with id, type, title, url, status, page and chunk counts, and a pagination object. Use Get Source for one source's indexed URLs and warnings.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
limitinteger- Sources per page. Defaults to 100. Example: 50.
pageinteger- Zero-based page number. Defaults to 0. Example: 1.
tagsstring- Comma-separated tag keys; returns sources with any of them. Use __untagged__ for sources with no tags. Standard plan and above. Example: billing,support.
docsbot_team_getGet one DocsBot team by ID.Read-onlyGet Team
Get one DocsBot team by ID. Returns its name, status, plan and limits, bot, source, page and chunk counts, AI credits used this period and a masked OpenAI key preview. Use List Teams to find team IDs.
Inputs
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_team_members_listList the members of a DocsBot team.Read-onlyList Team Members
List the members of a DocsBot team. Returns each member's user ID (uid), display name, email, avatar URL and role (owner, admin or member). Use the uid with Update Team Member Role or Remove Team Member.
Inputs
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_teams_listList every DocsBot team the API key's user belongs to.Read-onlyList Teams
List every DocsBot team the API key's user belongs to. Returns team summaries with id, name, status, plan limits, bot count and usage counts. Use Get Team for one team's full details.
Inputs
This tool takes no inputs.
docsbot_webhook_getGet one webhook on a bot.Read-onlyGet Webhook
Get one webhook on a bot. Returns its target URL, events, label, status and expiration date. Use List Webhooks to find webhook IDs.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
webhook_idstringrequired- Webhook ID. Get it from List Webhooks. Example: abc123.
docsbot_webhooks_listList the webhooks registered on a bot.Read-onlyList Webhooks
List the webhooks registered on a bot. Returns webhooks with id, target URL, events, label, status and expiration date. Use Get Webhook for one webhook.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_answer_rateRate a bot answer positive, negative or neutral.WriteRate Answer
Rate a bot answer positive, negative or neutral. Returns a success message; the rating appears in question history and fires conversation.rated webhooks. Use the answer id from Chat with Agent or Chat.
- Idempotent
Inputs
answer_idstringrequired- Answer (question) ID: the id of a lookup_answer event from Chat Agent, or the id returned by Chat. Example: FHSGF2524i25xbZRyySL.
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
ratingintegerrequired- 1 for a positive rating, -1 for negative, 0 to reset. Example: 1.one of
-101 team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_answer_support_logRecord that a user clicked through to support after an answer, for statistics.WriteLog Support Request
Record that a user clicked through to support after an answer, for statistics. Returns a success message. Use Escalate Conversation for confirmed Chat Agent escalations.
- Idempotent
Inputs
answer_idstringrequired- Answer (question) ID: the id of a lookup_answer event from Chat Agent, or the id returned by Chat. Example: FHSGF2524i25xbZRyySL.
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_bot_createCreate a new bot in a DocsBot team, optionally as a copy of an existing bot.WriteCreate Bot
Create a new bot in a DocsBot team, optionally as a copy of an existing bot. Returns the new bot with its id and status. Use Create Source next to train it.
Inputs
descriptionstringrequired- Bot description, shown by default in embeds and share links. Example: Ask me anything about Acme..
languagestringrequired- Bot language code, for example en or jp. Example: en.
namestringrequired- Bot name, shown publicly. Example: Acme Help Bot.
privacystringrequired- public or private. Private bots need a Bearer token for chat calls. Example: public.one of
publicprivate team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
copy_fromstring- ID of an existing bot in the team to copy, including its sources. Example: iADcTdrl7R51JiTjrWKy.
embedding_modelstring- Embedding model, depending on plan: text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002, embed-multilingual-v3.0 or embed-v4.0. Must match the source bot when copying. Example: text-embedding-3-large.
modelstring- AI model: gpt-6-luna (default), gpt-6.1-terra, gpt-6.1-sol or gpt-6-astra. Example: gpt-6-luna.
retriever_tagsarray- Source tag vocabulary for targeted retrieval (Standard plan and above). Each entry has a key (lowercase slug) and a description. Example: [{"key": "billing", "description": "Billing and invoices"}].
docsbot_bot_updateUpdate a DocsBot bot's settings, such as name, prompt, privacy, model, widget appearance, tools or retriever tags.WriteUpdate Bot
Update a DocsBot bot's settings, such as name, prompt, privacy, model, widget appearance, tools or retriever tags. Returns the updated bot. Fields left out are not changed. Use Get Bot to read the current settings. Widget changes can take up to 5 minutes to appear.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
alignmentstring- Side of the page for the chat bubble: left or right. Example: right.one of
leftright allowed_domainsarray- Hostnames the widget may be embedded on. An empty list allows all. Example: ["docs.acme.com"].
colorstring- Widget color in hex. Example: #1E40AF.
custom_promptstring- Custom prompt instructions (Standard plan and higher). Example: Always answer in a friendly tone..
descriptionstring- Bot description, shown in embeds and share links. Example: Ask me anything about Acme..
hide_sourcesboolean- Hide answer sources in the widget. Example: false.
labelsobject- Widget label copy, keyed by label name, for example firstMessage or inputPlaceholder. Example: {"firstMessage": "Hi! How can I help?"}.
languagestring- Bot language code, for example en. Example: en.
modelstring- AI model: gpt-6-luna, gpt-6.1-terra, gpt-6.1-sol or gpt-6-astra. Example: gpt-6.1-sol.
namestring- Bot name, shown publicly. Example: Acme Help Bot.
privacystring- public or private. Example: private.one of
publicprivate retriever_tagsarray- Source tag vocabulary (Standard plan and above). Each entry has a key and description. Removing a key also removes it from every source. Example: [{"key": "billing", "description": "Billing and invoices"}].
show_button_labelstring- Text for the support link button. Example: Contact support.
show_copy_buttonboolean- Show a copy-to-clipboard button after answers. Example: true.
support_linkstring- Link shown after bot replies. An empty string disables it. Example: https://acme.com/support.
toolsobject- Agent tool configuration: calendly, calcom and tidycal entries (enabled, instructions, url) and customButtons. Example: {"calendly": {"enabled": true, "instructions": "Offer a demo call", "url": "https://calendly.com/acme/demo"}}.
docsbot_chatAsk a bot one question with optional history (stateless legacy chat API).WriteChat (Legacy)
Ask a bot one question with optional history (stateless legacy chat API). Returns the answer, sources, question id and whether it could answer. Use Chat with Agent for stateful conversations with tools. Spends AI credits.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
questionstringrequired- The question to ask, 2 to 500 characters. Example: How do I reset my password?.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
context_itemsinteger- Number of sources to look up. Defaults to 5. Example: 5.
formatstring- Answer format: markdown (default) or text. Example: markdown.one of
markdowntext full_sourceboolean- Return the full source content with each source. Example: false.
historyarray- Earlier turns as [question, answer] pairs, for follow-up questions. Example: [["What is Acme?", "Acme is a support platform."]].
metadataobject- User details saved with the question. Example: {"email": "jane@example.com"}.
testingboolean- Mark as a test question. Example: true.
docsbot_chat_agentSend a message to a bot's Chat Agent in a stateful conversation and get its reply (non-streaming).WriteChat with Agent
Send a message to a bot's Chat Agent in a stateful conversation and get its reply (non-streaming). Returns a list of events, including lookup_answer with the answer, sources and question id, and any support_escalation or tool events. Use the same conversation_id for follow-ups. Use Semantic Search to fetch sources without an answer. Spends AI credits.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- UUID for the conversation. Reuse it to continue a conversation; send a new UUID to start one. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
questionstringrequired- The user's message, 2 to 500 characters (up to about 32,000 when authenticated). Example: How do I reset my password?.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
context_itemsinteger- Number of sources to look up. Defaults to 5. Example: 5.
default_languagestring- Locale to use when the conversation language is unclear, for example en or en-US. Example: en.
document_retrieverboolean- Enable the documentation search tool. Defaults to true. Example: true.
followup_ratingboolean- Enable the follow-up rating question tool. Example: false.
formatstring- Answer format: markdown (default) or text. Example: markdown.one of
markdowntext human_escalationboolean- Enable the human escalation detection tool. Example: false.
image_urlsarray- Image URLs to include as context (supported models only). Example: ["https://example.com/screenshot.png"].
metadataobject- User details saved with the conversation; name, email and referrer show in logs. Example: {"name": "Jane Doe", "email": "jane@example.com"}.
modelstring- Override the bot's model for this request. Example: gpt-6.1-sol.
testingboolean- Mark the conversation as a test so it is excluded from stats. Example: true.
docsbot_conversation_escalateLog a confirmed human-support escalation on a conversation.WriteEscalate Conversation
Log a confirmed human-support escalation on a conversation. Returns a success message; sets escalated to handled and fires conversation.escalated webhooks. Call it after the user confirms a support_escalation from Chat with Agent.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_conversation_lead_captureSave a lead from a conversation and merge its details into the conversation metadata.WriteCapture Lead
Save a lead from a conversation and merge its details into the conversation metadata. Returns a success message and fires lead.created webhooks. Use List Leads to read captured leads.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
metadataobjectrequired- Lead details, such as name, email and company. Merged into the conversation metadata. Example: {"name": "Jane Doe", "email": "jane@example.com", "company": "Acme Corp"}.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
full_changeboolean- true replaces all metadata; false (default) merges into it. Example: false.
docsbot_conversation_metadata_updateUpdate the user metadata stored on a conversation, merging by default.WriteUpdate Conversation Metadata
Update the user metadata stored on a conversation, merging by default. Returns a success message. Use Capture Lead to also save the user as a lead.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
metadataobjectrequired- Metadata to store on the conversation, such as name and email. Example: {"name": "Jane Doe", "plan": "pro"}.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
full_changeboolean- true replaces all metadata; false (default) merges into it. Example: false.
docsbot_conversation_summarizeGenerate (or return the cached) summary of a conversation.WriteSummarize Conversation
Generate (or return the cached) summary of a conversation. Returns a title, summary text and sentiment. Use Generate Support Ticket for a help-desk ticket instead. May spend AI credits.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_conversation_ticket_generateGenerate a structured support ticket from a conversation's history.WriteGenerate Support Ticket
Generate a structured support ticket from a conversation's history. Returns a ticket subject and detailed content for a help desk. Use Summarize Conversation for a short summary. May spend AI credits.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_research_continueAnswer a deep research job's clarifying questions so it continues.WriteContinue Deep Research
Answer a deep research job's clarifying questions so it continues. Returns the job with its new status. Use Get Research Job to poll until it completes.
Inputs
answersstringrequired- Answers to the job's clarifying questions. Example: Focus on EU customers and annual plans..
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
job_idstringrequired- Deep research job ID, returned by Start Deep Research or List Research Jobs. Example: rj_8Kx2mQ4pLz.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
modelstring- Override the research model for this job. Example: gpt-6.1-sol.
web_searchboolean- Override web search. Example: true.
docsbot_research_startStart a deep research job that searches a bot's docs (and optionally the web) to answer a complex question.WriteStart Deep Research
Start a deep research job that searches a bot's docs (and optionally the web) to answer a complex question. Returns the job ID and status; the job may ask clarifying questions. Use Get Research Job to poll and Continue Deep Research to answer clarifications. Spends AI credits.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
questionstringrequired- The research question or task. Example: Compare our refund policy with industry norms..
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
code_interpreterboolean- Enable the code interpreter. Example: false.
docs_searchboolean- Search the bot's documentation. Defaults to true. Example: true.
metadataobject- User details; name and email are recognized. Example: {"email": "jane@example.com"}.
modelstring- Research model tier: gpt-6-luna (default), gpt-6.1-terra, gpt-6.1-sol or gpt-6-astra. Example: gpt-6-luna.one of
gpt-6-lunagpt-6.1-terragpt-6.1-solgpt-6-astra question_historyboolean- Search the bot's question history. Example: false.
tagsarray- Only search documentation chunks with these source tags. Example: ["billing"].
web_searchboolean- Enable web search. Example: false.
docsbot_source_createAdd a training source to a bot, such as a web page, sitemap, YouTube video, RSS feed or Q&A pairs.WriteCreate Source
Add a training source to a bot, such as a web page, sitemap, YouTube video, RSS feed or Q&A pairs. Returns the new source with status pending; it indexes in the background. Use Get Source to check progress. File uploads are not supported by this tool.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
typestringrequired- Source type: url, sitemap, youtube, rss or qa work with this tool directly; document, wp, urls and csv need a file already uploaded to DocsBot storage. Example: url.one of
urlsitemapyoutuberssqadocumentwpurlscsv faqsarray- Question and answer pairs. Required for qa type. Example: [{"question": "What is Acme?", "answer": "Acme is a support platform."}].
filestring- Storage path of an already uploaded file, for file-based types. Example: teams/FOX1XkWo8VMx3hp6Zjkb/bots/SQMV36O8xi43xbZRzYLy/uploads/report.pdf.
ocrboolean- Advanced layout-aware document parsing (Standard plan and higher; 2 AI credits per page). Example: false.
process_imagesboolean- Describe images during ingest (Standard plan and higher). Example: false.
schedule_intervalstring- Refresh schedule: daily, weekly, monthly or none (default), depending on plan. Example: weekly.one of
dailyweeklymonthlynone tagsarray- Tag keys to assign, from the bot's retriever tags (Standard plan and higher). Example: ["billing"].
titlestring- Source title. Required for document type; a dashboard label for other types. Example: Acme docs.
urlstring- Source URL. Required for url, sitemap, youtube and rss types. Example: https://docs.acme.com/getting-started.
docsbot_source_retryRetry indexing a source whose status is failed.WriteRetry Source
Retry indexing a source whose status is failed. Returns the source with its new status. Use Get Source to check its status first.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_source_title_updateChange a source's dashboard title without reindexing.WriteUpdate Source Title
Change a source's dashboard title without reindexing. Returns the updated source. Only URL list, website, sitemap and multi-file document sources support this; others return 409.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
titlestringrequired- New dashboard title. An empty string clears it. Example: Partner documentation URLs.
docsbot_team_createCreate a new DocsBot team owned by the API key's user.WriteCreate Team
Create a new DocsBot team owned by the API key's user. Returns the new team with its id, name, status and plan. Use Create Bot next to add a bot to the team.
Inputs
namestring- Team name. If omitted, DocsBot names the team from the user's profile or email. Example: Acme Support.
docsbot_team_invite_sendSend an email invitation to join a DocsBot team.WriteInvite Team Member
Send an email invitation to join a DocsBot team. Returns a confirmation message. The invitee receives an email. Use Remove Team Member with remove_user_email to revoke the invite.
Inputs
invite_emailstringrequired- Email address of the person to invite. Example: newuser@example.com.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
rolestring- Role the invited user gets on joining: admin or member. Example: member.one of
adminmember
docsbot_team_member_role_updateChange a team member's role to admin or member.WriteUpdate Team Member Role
Change a team member's role to admin or member. Returns the updated member list. Use List Team Members to find the member's uid.
- Idempotent
Inputs
member_idstringrequired- User ID (uid) of the member to change. Get it from List Team Members. Example: u8Hq2LmN3pR5sT7v.
rolestringrequired- New role for the member: admin or member. Example: admin.one of
adminmember team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_team_updateRename a DocsBot team.WriteUpdate Team
Rename a DocsBot team. Returns the updated team. Use Get Team to read the current settings.
- Idempotent
Inputs
namestringrequired- New team name. Example: Acme Support.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_webhook_createSubscribe a URL to a bot's lead, deep research, escalation or rating events.WriteCreate Webhook
Subscribe a URL to a bot's lead, deep research, escalation or rating events. Returns the new webhook with its id and status. Use List Webhooks to see existing subscriptions.
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
eventsarrayrequired- Events to subscribe to: lead.created, deep_research.done, conversation.escalated, conversation.rated. Example: ["lead.created", "conversation.escalated"].
target_urlstringrequired- HTTPS URL that receives the webhook POSTs. Example: https://example.com/webhooks/docsbot.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
expiration_datestring- ISO date-time after which the webhook stops. Example: 2027-03-15T00:00:00.000Z.
labelstring- Label to identify the webhook. Example: CRM sync.
docsbot_webhook_updateUpdate a webhook's status, target URL, label or expiration date.WriteUpdate Webhook
Update a webhook's status, target URL, label or expiration date. Returns the updated webhook. Use Get Webhook to read the current values.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
webhook_idstringrequired- Webhook ID. Get it from List Webhooks. Example: abc123.
expiration_datestring- New ISO expiration date-time. Example: 2027-03-15T00:00:00.000Z.
labelstring- New label. Example: CRM sync.
statusstring- Webhook status, for example active (as returned by Get Webhook). Example: active.
target_urlstring- New HTTPS target URL. Example: https://example.com/webhooks/docsbot.
docsbot_bot_deletePermanently delete a DocsBot bot and its sources.DestructiveDelete Bot
Permanently delete a DocsBot bot and its sources. Returns a success message. Use List Bots to find the bot ID first.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_conversation_deleteDelete a conversation from a bot's history.DestructiveDelete Conversation
Delete a conversation from a bot's history. Returns a success message. Use List Conversations to find the conversation ID.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
conversation_idstringrequired- Conversation ID (the UUID used with Chat Agent). Get it from List Conversations. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_lead_deleteDelete one lead record from a bot.DestructiveDelete Lead
Delete one lead record from a bot. Returns a success message. Use List Leads to find the lead ID.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
lead_idstringrequired- Lead ID (the conversation ID the lead came from). Get it from List Leads. Example: 3f6c1d2e-8a4b-4c1d-9e7f-2a1b3c4d5e6f.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_question_deleteDelete one question from a bot's question history.DestructiveDelete Question
Delete one question from a bot's question history. Returns a success message. Use List Questions to find the question ID.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
question_idstringrequired- Question ID, from List Questions or a Chat Agent lookup_answer event. Example: FHSGF2524i25xbZRyySL.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_research_cancelCancel a running deep research job.DestructiveCancel Deep Research
Cancel a running deep research job. Returns the cancelled job. Use List Research Jobs to find running jobs.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
job_idstringrequired- Deep research job ID, returned by Start Deep Research or List Research Jobs. Example: rj_8Kx2mQ4pLz.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_source_deleteDelete a training source from a bot.DestructiveDelete Source
Delete a training source from a bot. It may still appear in answers for a few minutes. Returns a success message. Use List Sources to find the source ID.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
source_idstringrequired- Source ID. Get it from List Sources. Example: qGDSDhbdxtqmifTZQrYs.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
docsbot_team_member_removeRemove a member from a DocsBot team, or revoke an outstanding invite by email.DestructiveRemove Team Member
Remove a member from a DocsBot team, or revoke an outstanding invite by email. Returns a success message. Provide remove_user_id for a member or remove_user_email for an invite.
- Idempotent
Inputs
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
remove_user_emailstring- Email address of an outstanding invite to revoke. Provide this or remove_user_id. Example: newuser@example.com.
remove_user_idstring- User ID (uid) of the member to remove from the team. Provide this or remove_user_email. Example: u8Hq2LmN3pR5sT7v.
docsbot_webhook_deleteDelete a webhook subscription from a bot.DestructiveDelete Webhook
Delete a webhook subscription from a bot. Returns a success message with the webhook ID. Use List Webhooks to find the webhook ID.
- Idempotent
Inputs
bot_idstringrequired- DocsBot bot ID. Get it from List Bots. Example: SQMV36O8xi43xbZRzYLy.
team_idstringrequired- DocsBot team ID. Find it on the API page of the DocsBot dashboard or with List Teams. Example: FOX1XkWo8VMx3hp6Zjkb.
webhook_idstringrequired- Webhook ID. Get it from List Webhooks. Example: abc123.
No tools match.