66 lines
1.5 KiB
Markdown
66 lines
1.5 KiB
Markdown
---
|
|
name: ai-agents-routes
|
|
description: Handle 5 OpenAPI operation(s) under /ai_agents for the ai agents route group.
|
|
---
|
|
|
|
# ai agents API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /ai_agents for the ai agents route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_ai_agents
|
|
|
|
- Operation ID: `get_ai_agents`
|
|
- Route: `GET /ai_agents`
|
|
- Mode: READ
|
|
- Summary: List AI agents
|
|
- Parameters:
|
|
- `mode` in `query`
|
|
- `fields` in `query`
|
|
- `agent_state` in `query`
|
|
- `include_box_default` in `query`
|
|
- `marker` in `query`
|
|
- `limit` in `query`
|
|
|
|
### post_ai_agents
|
|
|
|
- Operation ID: `post_ai_agents`
|
|
- Route: `POST /ai_agents`
|
|
- Mode: WRITE
|
|
- Summary: Create AI agent
|
|
- Body: JSON request body accepted.
|
|
|
|
### put_ai_agents_id
|
|
|
|
- Operation ID: `put_ai_agents_id`
|
|
- Route: `PUT /ai_agents/{agent_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update AI agent
|
|
- Parameters:
|
|
- `agent_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_ai_agents_id
|
|
|
|
- Operation ID: `get_ai_agents_id`
|
|
- Route: `GET /ai_agents/{agent_id}`
|
|
- Mode: READ
|
|
- Summary: Get AI agent by agent ID
|
|
- Parameters:
|
|
- `agent_id` in `path` required
|
|
- `fields` in `query`
|
|
|
|
### delete_ai_agents_id
|
|
|
|
- Operation ID: `delete_ai_agents_id`
|
|
- Route: `DELETE /ai_agents/{agent_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete AI agent
|
|
- Parameters:
|
|
- `agent_id` in `path` required
|