feat: add AI Agents OpenAPI spec with BYO and Agent Builder API sections#276
feat: add AI Agents OpenAPI spec with BYO and Agent Builder API sections#276Afroz-Cometchat wants to merge 37 commits intomainfrom
Conversation
…ns, and error responses
Afroz-Cometchat
force-pushed
the
docs/ai-agents-apis
branch
from
fd0537a to
50a1671
Compare
…implementation notes
… to match moderation style
raj-dubey1
requested review from
jitvarpatil and
raj-dubey1
and removed request for
jitvarpatil and
raj-dubey1
…olders matching Chat APIs pattern
ai-agent-service.json
Outdated
| "tags": [ | ||
| "Agents" | ||
| ], | ||
| "description": "Creates a new BYO agent that delegates conversations to an external AI framework. Use this endpoint to register a BYO (Bring Your Own) agent powered by frameworks like Mastra, CrewAI, or LangGraph.\n\n**Validation:** All referenced tools and actions are validated before the agent is created.", |
There was a problem hiding this comment.
external AI Agent*
(check)
icon is required in payload.
BYO agent
-> BYO Agent
-> Remove this line: Use this endpoint to remove a BYO agent that is no longer needed.
-> tools: [] and actions: [] are not required in create BYOA api
(check in update as well)
-> remove line: Creates a new tool or action for the application.
Change wording:
Type assignment: The type is automatically determined by the doNotExecute flag — set to tool when true, action otherwise.
Change wording (nested etc sounds off):
Restrictions: The tool name cannot be changed after creation. The update is merged with existing tool data for the nested tool object (name, description, parameters).
remove:
-> Use this endpoint to remove a tool that is no longer needed.
ai-agent-service.json
Outdated
| "tags": [ | ||
| "Agent Builder" | ||
| ], | ||
| "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.\n\n**Validation:** All referenced tools, API tools, and MCP servers are validated before creation.\n\n**Default model:** The default AI model is assigned if none is specified." |
There was a problem hiding this comment.
Remove:
- Default model: The default AI model is assigned if none is specified.
(is this mentioned in any other docs)? If not, remove:
-
Pagination: Supports cursor-based pagination using createdAt timestamps with prepend/append navigation. Results are sorted by creation date in descending order.
-
Modify
Retrieves a specific agent by its unique identifier -> uid -
Remove:
Use this endpoint to remove an agent that is no longer needed. -
Modify (Check other docs):
API Key with fullAccess scope (why full access?) -
Fix wording:
Searches across all tool types available for an agent, including ready-to-use tool actions, API tools, and MCP servers.
(tool actions does not sound right - means right but reword it)
fix wording for title:
(List Agent Enabled Items)
…optional, remove redundant text
…n, redundant delete lines, unique slug wording
…ram descriptions matching notification logs style
…g identifiers with slugs
2 participants
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)