Endpoints to manage and interact with agent tasks.
5 endpoints tagged agent-tasks, each listing its
parameters and possible responses. Search or scroll the index below to
jump to a specific endpoint.
No endpoints match your search.
GET /agents/repos/{owner}/{repo}/tasks
Returns a list of tasks for a specific repository
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository. The name is not case sensitive. |
per_page | query | no | The number of results per page (max 100). |
page | query | no | The page number of the results to fetch. |
sort | query | no | The field to sort results by. Can be updated_at or created_at. |
direction | query | no | The direction to sort results. Can be asc or desc. |
state | query | no | Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled. |
is_archived | query | no | Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false. |
since | query | no | Only show tasks updated at or after this time (ISO 8601 timestamp) |
creator_id | query | no | Filter tasks by creator user ID. Accepts one or more user IDs. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Tasks retrieved successfully | yes |
| 400 | Bad request | yes |
| 401 | Authentication required | yes |
| 403 | Insufficient permissions | yes |
| 404 | Resource not found | yes |
| 422 | Validation Failed | yes |
POST /agents/repos/{owner}/{repo}/tasks
Starts a new Copilot cloud agent task for a repository.
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository. The name is not case sensitive. |
| Status | Description | Has JSON body |
|---|---|---|
| 201 | Task created successfully | yes |
| 400 | Problems parsing JSON | yes |
| 401 | Authentication required | yes |
| 403 | Insufficient permissions | yes |
| 422 | Validation Failed | yes |
GET /agents/repos/{owner}/{repo}/tasks/{task_id}
Returns a task by ID scoped to an owner/repo path
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository. The name is not case sensitive. |
task_id | path | yes | The unique identifier of the task. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Task retrieved successfully | yes |
| 400 | Bad request | yes |
| 401 | Authentication required | yes |
| 403 | Insufficient permissions | yes |
| 404 | Resource not found | yes |
| 422 | Validation Failed | yes |
GET /agents/tasks
Returns a list of tasks for the authenticated user
| Name | In | Required | Description |
|---|---|---|---|
per_page | query | no | The number of results per page (max 100). |
page | query | no | The page number of the results to fetch. |
sort | query | no | The field to sort results by. Can be updated_at or created_at. |
direction | query | no | The direction to sort results. Can be asc or desc. |
state | query | no | Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled. |
is_archived | query | no | Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false. |
since | query | no | Only show tasks updated at or after this time (ISO 8601 timestamp) |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Tasks retrieved successfully | yes |
| 400 | Bad request | yes |
| 401 | Authentication required | yes |
| 403 | Insufficient permissions | yes |
| 422 | Validation Failed | yes |
GET /agents/tasks/{task_id}
Returns a task by ID with its associated sessions
| Name | In | Required | Description |
|---|---|---|---|
task_id | path | yes | The unique identifier of the task. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Task retrieved successfully | yes |
| 400 | Problems parsing request | yes |
| 401 | Authentication required | yes |
| 403 | Insufficient permissions | yes |
| 404 | Resource not found | yes |
| 422 | Validation Failed | yes |