Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/create-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/agents
description: "Creates a new agent with optional tools, API tools, MCP servers, and frontend actions. Use this endpoint to set up a fully configured agent in a single request. **Validation:** All referenced tools,"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/delete-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/agents/{uid}
description: "Deletes an agent by its UID."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/get-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/agents/{uid}
description: "Retrieves a specific agent by its UID. Use this endpoint to inspect an agent's full configuration, including its tools, model, and instructions."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/agents/{uid}/enabled-items
description: "Retrieves all enabled items for a specific agent, categorized by type. Use this endpoint to see which tools, frontend actions, API tools, and MCP servers are currently enabled for an agent. **Categor"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/list-agents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/agents
description: "Retrieves a paginated list of agents for your CometChat app. Use this endpoint to browse, search, and manage your agents. **Search:** Use the `search` parameter to filter agents by name, description,"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/list-available-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/agents/available-models
description: "Lists the AI models available for agent creation. Returns model identifiers that can be used when creating or updating an agent's configuration."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/search-agent-tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/agents/{uid}/tools/search
description: "Searches across all tool types available for an agent, including ready-to-use tools, API tools, and MCP servers. Use this endpoint to find specific tools across all categories. **Filtering:** Use the"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/agents/update-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}
description: "Updates an existing agent by its UID. Use this endpoint to modify an agent's configuration, instructions, model, or connected tools. **Validation:** Referenced tools, API tools, and MCP servers are v"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/api-tools/add
description: "Adds one or more API tools to a specific agent. Use this endpoint to give an agent access to custom API tool integrations. **Request body:** The `apiTools` array contains API tool slugs. Returns the"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/api-tools
description: "Creates a new API tool configuration for the application. Use this endpoint to define a custom API endpoint that agents can call during conversations. **Uniqueness:** The slug must be unique per appl"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/api-tools/{slug}
description: "Deletes an API tool by its slug."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/api-tools/{slug}
description: "Retrieves a single custom API tool by its slug."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/api-tools
description: "Retrieves a paginated list of API tools for the application. Use this endpoint to browse and manage custom API tool configurations."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/api-tools/remove
description: "Removes one or more API tools from a specific agent. Use this endpoint to revoke API tool access from an agent. **Request body:** The `apiTools` array contains API tool slugs to remove. Returns the u"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/api-tools/{slug}
description: "Updates an existing API tool by its slug. Use this endpoint to modify an API tool's parameters, description, or endpoint configuration."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/frontend-actions/add
description: "Adds one or more frontend actions to a specific agent. Use this endpoint to enable an agent to trigger client-side UI operations. **Frontend actions** allow agents to interact with the user interface"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/frontend-actions
description: "Creates a new frontend action for the application. Use this endpoint to define a client-side UI operation that agents can trigger during conversations. **Uniqueness:** The trigger function must be un"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/frontend-actions/{id}
description: "Deletes a frontend action by its unique ID."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/frontend-actions/{id}
description: "Retrieves a single frontend action by its ID."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/frontend-actions
description: "Retrieves a paginated list of frontend actions for the application. Use this endpoint to browse and manage frontend action configurations."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/frontend-actions/remove
description: "Removes one or more frontend actions from a specific agent. Use this endpoint to revoke frontend action capabilities from an agent. **Request body:** The `frontendActions` array contains frontend act"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/frontend-actions/{id}
description: "Updates an existing frontend action by its unique ID. Use this endpoint to modify a frontend action's parameters, description, or trigger function."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}
description: "Associates uploaded files or text entries with an agent's knowledge base. Use this endpoint after uploading files via the Initiate File Uploads endpoint to make them available to the agent. **Source"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/text
description: "Creates a new text-based knowledge base entry. Use this endpoint to add custom text content that agents can reference during conversations. **Processing:** Accepts a title and text content, converts"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/knowledge-base/text/{uniqueId}
description: "Deletes a text-based knowledge base entry and all associated data by its unique ID. **Cleanup:** Removes the text content, associated embeddings, and any agent references to this entry."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/knowledge-base/uploads/{uniqueId}
description: "Deletes an uploaded file and all associated data from the knowledge base by its unique ID. **Cleanup:** Removes the file, associated embeddings, and any agent references to this file."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/knowledge-base/website/{uniqueId}
description: "Deletes a website crawl and all associated data from the knowledge base by its unique ID. **Cleanup:** Removes all crawled pages, associated embeddings, and any agent references to this website."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/di
description: "Retrieves all URLs discovered during a website crawl. Use this endpoint to review which pages were found before processing them."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/knowledge-base/{sourceType}/{uniqueId}/pag
description: "Retrieves paginated pages for a specific knowledge base source file. Use this endpoint to inspect the individual pages extracted from a knowledge base source."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/knowledge-base/text/{uniqueId}
description: "Retrieves a specific text-based knowledge base entry by its unique ID."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/uploads/initiate
description: "Generates presigned URLs and creates upload records for one or more files. Use this endpoint to prepare files for upload to the knowledge base. **Workflow:** After receiving the presigned URLs, uploa"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/knowledge-base
description: "Retrieves knowledge base records for the application. Use this endpoint to browse all knowledge base sources including files, text entries, and websites."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/knowledge-base/text
description: "Lists all text-based knowledge base entries for the app."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/d
description: "Retrieves the processing status of discovered URLs by their unique IDs. Use this endpoint to monitor the progress of URL crawling within a parent website crawl. **Behavior:** Only returns records for"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/status/poll
description: "Retrieves the indexing status for one or more knowledge base sources by their IDs. Use this endpoint to monitor the progress of file uploads, text entries, or website crawls being indexed. **Batch su"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/d
description: "Marks discovered URLs for exclusion and initiates batch crawling of the remaining URLs. Use this endpoint to selectively process pages discovered during a website crawl."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/knowledge-base/{sourceType}
description: "Removes files or text entries from an agent's knowledge base. Use this endpoint to disassociate specific sources from an agent without deleting the underlying content. **Source types:** Specify the s"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/knowledge-base/website/{parentUniqueId}/
description: "Retries the indexing process for specific pages under a website knowledge base source. Pass the unique IDs of the pages to re-index, or send an empty array to automatically retry all pages that failed"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/knowledge-base/{sourceType}/{uniqueId}/s
description: "Retries the indexing process for a specific knowledge base source that failed during its initial processing. Provide the source type and its unique ID to re-trigger vectorization. **Supported source"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/website/individual-page
description: "Scrapes a single webpage to extract its content for the knowledge base. Use this endpoint to add a specific page without crawling an entire website. **Extraction:** Returns the page title, descriptio"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/knowledge-base/website/scrape
description: "Scrapes a website to discover and crawl its pages for the knowledge base. Use this endpoint to add website content as a knowledge source for agents. **Configuration:** Supports options for URL filter"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/knowledge-base/text/{uniqueId}
description: "Updates a specific text-based knowledge base entry by its unique ID. Use this endpoint to modify the title or content of an existing text entry. **Re-indexing:** The content is re-uploaded and the en"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: patch /ai-agents/agent-builder/agents/{uid}/mcp/add
description: "Adds one or more MCP servers to a specific agent. Use this endpoint to connect an agent to additional Model Context Protocol servers. **Request body:** The `mcps` array contains MCP server slugs. Ret"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: post /ai-agents/agent-builder/mcp-servers
description: "Creates a new MCP (Model Context Protocol) server configuration for the application. Use this endpoint to register an MCP server that agents can connect to. **Uniqueness:** The slug must be unique pe"
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: delete /ai-agents/agent-builder/mcp-servers/{slug}
description: "Deletes an MCP server by its slug."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/mcp-servers/get-mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/mcp-servers/{slug}
description: "Retrieves a single MCP server configuration by its slug."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
2 changes: 1 addition & 1 deletion rest-api/ai-agents-apis/mcp-servers/list-mcp-servers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ openapi: get /ai-agents/agent-builder/mcp-servers
description: "Retrieves a paginated list of MCP servers for the application. Use this endpoint to browse and manage MCP server configurations."
---

For the complete error reference, see [Error Guide](/articles/error-guide).
For the complete error reference, see [Error Guide](/rest-api/ai-agents-apis/error-codes).
Loading