79 lines
2.0 KiB
Markdown
79 lines
2.0 KiB
Markdown
---
|
|
name: agents-routes
|
|
description: Handle 5 OpenAPI operation(s) under /agents for the agents route group.
|
|
---
|
|
|
|
# agents API Routes
|
|
|
|
Handle 5 OpenAPI operation(s) under /agents for the 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
|
|
|
|
### agent_tasks_list_tasks_for_repo
|
|
|
|
- Operation ID: `agent_tasks_list_tasks_for_repo`
|
|
- Route: `GET /agents/repos/{owner}/{repo}/tasks`
|
|
- Mode: READ
|
|
- Summary: List tasks for repository
|
|
- Parameters:
|
|
- `owner` in `path` required
|
|
- `repo` in `path` required
|
|
- `per_page` in `query`
|
|
- `page` in `query`
|
|
- `sort` in `query`
|
|
- `direction` in `query`
|
|
- `state` in `query`
|
|
- `is_archived` in `query`
|
|
- `since` in `query`
|
|
- `creator_id` in `query`
|
|
|
|
### agent_tasks_create_task_in_repo
|
|
|
|
- Operation ID: `agent_tasks_create_task_in_repo`
|
|
- Route: `POST /agents/repos/{owner}/{repo}/tasks`
|
|
- Mode: WRITE
|
|
- Summary: Start a task
|
|
- Parameters:
|
|
- `owner` in `path` required
|
|
- `repo` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### agent_tasks_get_task_by_repo_and_id
|
|
|
|
- Operation ID: `agent_tasks_get_task_by_repo_and_id`
|
|
- Route: `GET /agents/repos/{owner}/{repo}/tasks/{task_id}`
|
|
- Mode: READ
|
|
- Summary: Get a task by repo
|
|
- Parameters:
|
|
- `owner` in `path` required
|
|
- `repo` in `path` required
|
|
- `task_id` in `path` required
|
|
|
|
### agent_tasks_list_tasks
|
|
|
|
- Operation ID: `agent_tasks_list_tasks`
|
|
- Route: `GET /agents/tasks`
|
|
- Mode: READ
|
|
- Summary: List tasks
|
|
- Parameters:
|
|
- `per_page` in `query`
|
|
- `page` in `query`
|
|
- `sort` in `query`
|
|
- `direction` in `query`
|
|
- `state` in `query`
|
|
- `is_archived` in `query`
|
|
- `since` in `query`
|
|
|
|
### agent_tasks_get_task_by_id
|
|
|
|
- Operation ID: `agent_tasks_get_task_by_id`
|
|
- Route: `GET /agents/tasks/{task_id}`
|
|
- Mode: READ
|
|
- Summary: Get a task by ID
|
|
- Parameters:
|
|
- `task_id` in `path` required
|