DocsBot AI

Cancel Deep Research. (DELETE https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/research/{job_id})

Delete Bot. This endpoint deletes a specific bot by its ID. (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId})

Delete Conversation. This endpoint lets you delete a conversation from your bot's conversation log. Note: This endpoint requires edit permissions for the bot. (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId}/conversations/{conversationId})

Delete Lead. Deletes one lead document. Permissions: Requires bot edit access (owner, admin, editor). (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId}/leads/{leadId})

Delete Questions. This endpoint lets you delete questions from your bot's question log. To get the question ID when using the Chat Agent API, use the id from the lookup_answer event in the response, or fetch the conversation via the Conversations API and read the id from messages with type === "lookup_answer". See the Chat Agent API for details. Soft delete behavior: Delete is a soft delete: questions are not removed from the database. Instead, they are flagged with deleted: true and their content (question, answer, sources, etc.) is cleared. This allows us to retain records for plan usage tracking, analytics, and reports. Deleted questions still appear in the List Questions response—the API does not support filtering by deleted due to index limitations. If you need to exclude deleted questions, filter them client-side (e.g. questions.filter(q => !q.deleted)). (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId}/questions/{questionId})

Delete Source. This endpoint deletes a specific source by its ID. Please note however, that it may take several minutes for the sources to be completely removed from our services, meaning that sources may still be recommended in chat results for several minutes after deleting. (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId})

Delete Webhook (Unsubscribe). (DELETE https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/{webhookId})

Remove Team Member or Invite. This endpoint removes a team member or an outstanding invite. (DELETE https://docsbot.ai/api/teams/{teamId}/members)

List Libraries That Can Be Searched. (GET https://api.docsbot.ai/libraries)

List Teams. This endpoint lists all teams that the API key user has a role for. (GET https://docsbot.ai/api/teams)

Generate Conversation Summary. Creates or retrieves a summary of the conversation including title, summary text, and sentiment analysis. For private bots, requires authentication. Returns cached summary if available for unauthenticated requests. Requires the Standard plan or above; DocsBot answers 402 below it. (GET https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/conversations/{conv_id}/summarize)

Generate Support Ticket From Conversation. Generates a structured support ticket from an existing conversation. This endpoint analyzes the conversation history and creates a well-formatted support ticket with a subject line and detailed content suitable for submission to a help desk or support system. Returns a TicketResponse object containing the subject and formatted ticket content. Requires the Standard plan or above; DocsBot answers 402 below it. (GET https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/conversations/{conv_id}/ticket)

Research Job Status. (GET https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/research/{job_id})

Get Team. This endpoint fetches a specific team by its ID. (GET https://docsbot.ai/api/teams/{teamId})

List Bots. This endpoint lists all bots for a specific team. (GET https://docsbot.ai/api/teams/{teamId}/bots)

Get Bot. This endpoint fetches a specific bot by its ID. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId})

List Conversations. This endpoint lists all conversations for a given team and bot. Objects are a limited subset of conversation properties. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/conversations)

Get Single Conversation. This endpoint retrieves a specific conversation by its ID, returning all the data. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/conversations/{conversationId})

Create Bot Image Upload URL. This endpoint creates a short-lived signed upload URL for a bot widget image. Use it when you want to upload a custom chat bubble icon, chat avatar, or header logo, then save the returned public CDN URL on the bot with Update Bot. This endpoint is only for bot branding images. Do not use the source file upload endpoint for widget images. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/image-upload-url)

List Leads. Lists leads for a bot. Permissions: Requires bot view access (owner, admin, editor, viewer; denied for none). (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/leads)

Export Leads CSV. Exports leads matching a date range to a signed CSV URL. Permissions: Requires bot export permission (owner, admin, editor). Also requires a plan with log export enabled. Plan gates: Also requires a plan with log export enabled (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/leads/export)

List Questions. This endpoint lists all questions asked of a given team and bot. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/questions)

Bot Reports (Monthly). This endpoint returns the list of available monthly reports and the report data for a selected month. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/reports)

List Research Jobs. This endpoint lists deep research jobs for a bot. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/research)

Get Research Job Details. This endpoint retrieves a single research job by ID. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/research/{jobId})

List Sources. This endpoint lists sources for the given team and bot with pagination. Plan gates: tags: Requires Standard plan or higher (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources)

Get Source. This endpoint fetches a specific source by its ID. This will return the full source object unlike listing. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId})

Download uploaded file (download). Use when: Single-file sources (no files array). Both endpoints return a JSON object with a signed url and suggested filename. The fileName query parameter accepts either the relative path from files[].p (for example guides/setup.pdf) or just the basename. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId}/download)

Download uploaded file (download-file). Use when: Multi-file sources; download one member file by its p value. Both endpoints return a JSON object with a signed url and suggested filename. The fileName query parameter accepts either the relative path from files[].p (for example guides/setup.pdf) or just the basename. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId}/download-file)

Get Source Tag Counts. Returns how many sources are assigned to each configured tag key, plus an untagged count. Useful for building tag filter UIs without paginating through every source. Requires Standard plan or higher (bot must have retrieverTags configured). Plan gates: Requires Standard plan or higher (bot must have retrieverTags configured) (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/tag-counts)

Get Bot Statistics. This endpoint provides aggregated statistics for a bot over a specified time period. Plan gates: avgSentimentData: number[] Average sentiment scores per date (agent mode only, business plan) | conversationTopicLabels: string[] Labels for conversation topics (agent mode only, business plan) | conversationTopicData: object Topic data per date, keyed by topic name (agent mode only, business plan) | conversationTopicPieLabels: string[] Labels for topic distribution pie chart (agent mode only, business plan) | conversationTopicCounts: number[] Counts for topic distribution (agent mode only, business plan) | Some fields (like sentiment data and topic analytics) require specific plan levels (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/stats)

Create a Presigned Upload URL. We do not support POSTing binary files directly with the create source endpoint. Instead, upload files to temporary cloud storage with presigned URLs, then reference those paths when you create the source. Temporary uploads live under user/{userId}/team/{teamId}/bot/{botId}/ and are automatically purged after 24 hours. Request a presigned upload URL for each file you want to upload. The fileName parameter is appended to the temp upload prefix. It may include subdirectories (for example upload_123_abc12/docs/report.pdf) when uploading multiple files into the same folder. Filenames are preserved as provided (including spaces) so existing single-file upload scripts remain compatible; only path traversal and other unsafe values are rejected. The endpoint returns: url — PUT the file bytes here with Content-Type: application/octet-stream.; file — The temp storage path to pass as file when creating a single-file source, or as part of a fileDir prefix for multi-file sources. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/upload-url)

List registered webhooks. DocsBot documents this only as a one-line summary. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks)

Get one webhook. DocsBot documents this only as a one-line summary. (GET https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/{webhookId})

List Team Members. This endpoint lists all members for a given team. (GET https://docsbot.ai/api/teams/{teamId}/members)

Update Source Title. Update the dashboard label for a source without reindexing. Only URL list (urls), website-mapped URL lists (website), sitemap, and multi-file document sources support title updates. Single-file documents store the title in the vector index, so PATCH returns HTTP 409. All other source types return HTTP 409 as well. (PATCH https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId})

Update status, target URL, label, expiration. DocsBot documents this only as a one-line summary. Request body not documented. (PATCH https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/{webhookId})

Create Team. This endpoint creates a new team for the API key user. (POST https://docsbot.ai/api/teams)

Question And Answer (Legacy). (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/ask)

Chat Or Question And Answer. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/chat)

Chat Or Question And Answer Using Retreival Agent. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/chat-agent)

Capture Lead And Update Conversation Metadata. Capture lead by updating conversation metadata and saving to leads collection. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/conversations/{conv_id}/lead)

Fetch Document. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/fetch)

Start Deep Research. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/research)

Continue Deep Research. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/research/{job_id})

Semantic Search. (POST https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/search)

Create Bot. This endpoint creates a new bot in a team. Plan gates: embeddingModel: Default is text-embedding-3-small for free plans, text-embedding-3-large for paid English bots, and embed-v4 | retrieverTags: Requires Standard plan or above (POST https://docsbot.ai/api/teams/{teamId}/bots)

Create Source. This endpoint creates a new source for a bot. Plan gates: processImages: Requires Standard plan or higher | ocr: Requires Standard plan or higher | tags: Requires Standard plan or higher (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources)

Update Source Tags. Assign, add, remove, or replace tags on one or more existing sources. Tag keys must come from the bot's configured retrieverTags vocabulary. When tags change on an already-indexed source, indexed chunks are updated to match. Requires Standard plan or higher. Plan gates: Requires Standard plan or higher (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/tags)

Create Webhook (Subscribe). (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks)

Trigger a conversation.escalated webhook delivery test. DocsBot documents this only as a one-line summary. Request body not documented. (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/deliver-escalated)

Trigger a lead webhook delivery test. DocsBot documents this only as a one-line summary. Request body not documented. (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/deliver-lead)

Trigger a conversation.rated webhook delivery test. DocsBot documents this only as a one-line summary. Request body not documented. (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/deliver-rated)

Trigger a deep research webhook delivery test. DocsBot documents this only as a one-line summary. Request body not documented. (POST https://docsbot.ai/api/teams/{teamId}/bots/{botId}/webhooks/deliver-research)

Invite a Team Member. This endpoint sends a team invitation email. (POST https://docsbot.ai/api/teams/{teamId}/invite)

Update Metadata Of Conversation. Update metadata of Conversation. (PUT https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/conversations/{conv_id})

Log A Support Escalation For The Conversation. Add an escalation to a conversation. (PUT https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/conversations/{conv_id}/escalate)

Rate An Answer. (PUT https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/rate/{answer_id})

Log A Support Request. (PUT https://api.docsbot.ai/teams/{team_id}/bots/{bot_id}/support/{answer_id})

Update Team. This endpoint updates specific fields for a specific team by its ID. (PUT https://docsbot.ai/api/teams/{teamId})

Update Bot. This endpoint updates specific fields for a specific bot by its ID. Plan gates: customPrompt: Only editible on Pro plan and higher | retrieverTags: Requires Standard plan or above | Plan — Standard plan or higher (PUT https://docsbot.ai/api/teams/{teamId}/bots/{botId})

Retry Source. If a source has status failed, you can trigger an index retry. (PUT https://docsbot.ai/api/teams/{teamId}/bots/{botId}/sources/{sourceId})

Respond to an Invite. This endpoint accepts, denies, or retries an invite. `inviteId` must name an invite that ALREADY EXISTS on this team: DocsBot looks the invite document up without checking it is there, so an unknown or absent id answers HTTP 500 'Value for argument "documentPath" is not a valid resource path' or 'Cannot read properties of undefined (reading email)' -- neither means the credential or the team is wrong (measured 2026-09-16). Invites are created by the Invite a Team Member tool, and a free team cannot hold a second member. KNOWN PROVIDER FAULT, measured 2026-09-13: with NO body at all the route answers 500 FUNCTION_INVOCATION_FAILED even with no credential (GET answers 405, so the route exists and crashes). (PUT https://docsbot.ai/api/teams/{teamId}/invite)

Update Team Member Role. This endpoint updates a member role for a team. (PUT https://docsbot.ai/api/teams/{teamId}/members)