API_KEY
docsbot_ai_api_key
Developer setup
No fields declared in this snapshot.
User connection
- DocsBot AI API Keygeneric_api_key · stringRequired
DOCSBOT_AI
DocsBot AI enables the creation of custom chatbots trained on your documentation, facilitating automated customer support and content generation.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
38
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 1–30 of 38 actions
DOCSBOT_AI_CAPTURE_CONVERSATION_LEAD
Tool to capture lead information by updating conversation metadata and saving the lead. Works whether or not the conversation has been created yet.
Untrusted display-only summary
DOCSBOT_AI_CREATE_BOT
Tool to create a new bot within a team. Use when you have a valid team ID and want to provision a new bot.
Untrusted display-only summary
DOCSBOT_AI_CREATE_SOURCE
Tool to create a new source for a bot. Sources can be URLs, files, sitemaps, and other types. Use when you have content to add to a bot's knowledge base. For file-based sources, first upload the file using the Upload File to Cloud Storage action.
Untrusted display-only summary
DOCSBOT_AI_CREATE_WEBHOOK
Tool to create a new webhook subscription for a bot. Use when you want to receive real-time notifications for specific events (lead.created, deep_research.done, conversation.escalated, conversation.rated). The target URL must be publicly accessible and support HTTPS.
Untrusted display-only summary
DOCSBOT_AI_DELETE_BOT
Tool to delete a specific bot by its ID. Use after confirming the bot ID is correct to permanently remove a bot from the system.
Untrusted display-only summary
DOCSBOT_AI_DELETE_CONVERSATION
Tool to delete a specific conversation by its ID. Use after confirming the conversation ID is correct to permanently remove a conversation. Requires edit permission.
Untrusted display-only summary
DOCSBOT_AI_DELETE_LEAD
Tool to delete a specific lead by ID. Use after confirming the lead ID to permanently remove a lead record from the system.
Untrusted display-only summary
DOCSBOT_AI_DELETE_QUESTION
Tool to delete a specific question from history. Use after confirming the question ID to permanently remove a question log entry from the system.
Untrusted display-only summary
DOCSBOT_AI_DELETE_SOURCE
Tool to delete a specific source from a bot by its ID. Use after confirming the source ID is correct to permanently remove a source from the bot's knowledge base.
Untrusted display-only summary
DOCSBOT_AI_DELETE_WEBHOOK
Tool to delete a webhook (unsubscribe) by its ID. Use after confirming the webhook ID is correct to permanently remove a webhook subscription.
Untrusted display-only summary
DOCSBOT_AI_DOCSBOT_CONVERSATION_TICKET_CREATION
Generates a structured support ticket from a Chat Agent conversation. Use this tool to convert an existing bot conversation into a formatted helpdesk ticket containing a subject line and message body written from the user's perspective. Prerequisites: - Requires a conversation created via the Chat Agent API (not the l…
Untrusted display-only summary
DOCSBOT_AI_GET_BOT
Tool to fetch details of a specific bot by ID within a team. Use after confirming valid team and bot IDs.
Untrusted display-only summary
DOCSBOT_AI_GET_BOT_REPORTS
Tool to retrieve monthly statistical reports for a bot. Returns question resolution metrics for a selected month. Use this to analyze bot performance and track question resolution trends over time.
Untrusted display-only summary
DOCSBOT_AI_GET_BOT_STATS
Tool to retrieve comprehensive statistics and analytics for a bot over a time period or date range. Returns key metrics (resolution rate, deflection rate, time saved), time series data for questions and ratings, distribution data for feedback and escalations, and agent mode conversation analytics. Use after confirming…
Untrusted display-only summary
DOCSBOT_AI_GET_SOURCE
Tool to retrieve detailed information about a specific source by its ID. Use when you need complete metadata about a source including indexed URLs, FAQs, and processing status.
Untrusted display-only summary
DOCSBOT_AI_GET_TEAM
Tool to fetch details of a specific team by its ID. Use when you need full team info including members and settings after confirming the team ID.
Untrusted display-only summary
DOCSBOT_AI_GET_UPLOAD_URL
Get a presigned upload URL for uploading files as sources. Use this before uploading large files to DocsBot. The workflow is: 1) Get upload URL, 2) Upload file to the URL, 3) Create source with the file path.
Untrusted display-only summary
DOCSBOT_AI_GET_WEBHOOK
Tool to retrieve details of a specific webhook by ID. Use when you need webhook configuration, delivery status, or subscription details.
Untrusted display-only summary
DOCSBOT_AI_LIST_BOTS
List all bots for a given team. Returns detailed information about each bot including configuration, statistics, and status. Use this action to discover available bots before performing operations like getting bot details or listing sources.
Untrusted display-only summary
DOCSBOT_AI_LIST_CONVERSATIONS
Tool to list conversation history for a bot with pagination. Returns a limited subset of conversation properties including titles, timestamps, sentiment, and status. Use this to discover conversations before retrieving full details.
Untrusted display-only summary
DOCSBOT_AI_LIST_LEADS
Tool to list captured leads for a bot with pagination and date filtering. Use after confirming valid team and bot IDs. Example: "List leads for bot abc123 starting from 2024-01-01."
Untrusted display-only summary
DOCSBOT_AI_LIST_QUESTIONS
Tool to list all questions asked of a specific bot. Use after confirming the bot's identifier. Example: "List questions for bot abc123 with status 'unanswered'."
Untrusted display-only summary
DOCSBOT_AI_LIST_RESEARCH_JOBS
Tool to list all deep research jobs for a bot with pagination support. Use after confirming valid team and bot IDs. Returns details about each research job including status, question, and timestamps.
Untrusted display-only summary
DOCSBOT_AI_LIST_SOURCES
Retrieves a paginated list of all sources for a specific bot within a team. Sources are the content (URLs, files, sitemaps, etc.) that have been indexed for the bot's knowledge base. Use this to see what data sources a bot has been trained on.
Untrusted display-only summary
DOCSBOT_AI_LIST_TEAM_MEMBERS
Tool to list all members of a team including their roles. Use when you need to see who has access to a team and their permission levels.
Untrusted display-only summary
DOCSBOT_AI_LIST_TEAMS
Tool to list all teams. Use when you need to retrieve every team associated with the authenticated user.
Untrusted display-only summary
DOCSBOT_AI_LIST_WEBHOOKS
List all registered webhooks for a bot. Returns webhook configurations including target URLs, subscribed events, and status. Use this action to discover configured webhooks before creating, updating, or deleting them.
Untrusted display-only summary
DOCSBOT_AI_RATE_ANSWER
Tool to rate an answer from chat APIs as positive (1), neutral (0), or negative (-1). Use when recording user feedback on bot responses for statistics shown in chat logs.
Untrusted display-only summary
DOCSBOT_AI_REFRESH_SOURCE
Tool to refresh a source to re-index its content. Use when a source needs to be updated with the latest content from its origin. Only works with failed sources for retry purposes.
Untrusted display-only summary
DOCSBOT_AI_SEARCH_SEMANTIC
Tool to perform semantic search on a bot's indexed content. Returns the most relevant source chunks for a query. Use when you need to search the bot's knowledge base without triggering a full conversation.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.