diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index af082a9487..49367d65e1 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -522,3173 +522,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -17828,7 +14661,27 @@ } }, "404": { - "$ref": "#/components/responses/not_found" + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index e153e0895d..a296afc688 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -338,2461 +338,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -13052,7 +10597,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 1f62f172d3..15e3f87f5d 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -522,3173 +522,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -17594,230 +14427,253 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { - "post": { - "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", - "minLength": 1, - "maxLength": 256 - }, - "digest": { - "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", - "minLength": 71, - "maxLength": 71, - "pattern": "^sha256:[a-f0-9]{64}$" - }, - "version": { - "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - }, - "return_records": { - "type": "boolean", - "default": true, - "description": "If true, the endpoint will return the set records in the response body\n" - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + "post": { + "summary": "Set cluster deployment records", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the set records in the response body\n" + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - }, - "required": [ - "total_count" - ] + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" }, "examples": { - "insufficient_repo_permissions": { + "not_found": { "value": { "message": { - "cause": "artifact metadata write permission required on one or more repositories", + "cause": "One or more repositories do not exist", "repositories": [ - 123, - 345 + "repoA", + "repoB" ] } } @@ -17825,9 +14681,6 @@ } } } - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -296216,10 +293069,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", @@ -300331,7 +297180,6 @@ "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", @@ -307492,7 +304340,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -309047,7 +305894,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -309184,12 +306030,6 @@ "remaining": 10, "reset": 1691591091 } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 } } }, @@ -309287,7 +306127,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "has_discussions": false, "archived": false, "disabled": false, @@ -318176,26 +315015,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -318896,26 +315715,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -319758,27 +316557,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -321157,27 +317935,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -322774,10 +319531,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -322999,7 +319752,6 @@ ] } ], - "cvss": null, "cvss_severities": { "cvss_v3": null, "cvss_v4": null @@ -323755,7 +320507,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -324227,7 +320978,6 @@ } ], "state": "open", - "assignee": null, "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -324645,7 +321395,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 7235c9a748..d013dfc2a9 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -338,2461 +338,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -13050,7 +10595,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -217407,9 +214964,6 @@ components: vulnerable_version_range: "<=1.0.2" vulnerable_functions: - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H @@ -221245,7 +218799,6 @@ components: updated_at: '2011-06-20T11:34:15Z' description: Hello World Examples comments: 0 - user: comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ owner: login: octocat @@ -227316,7 +224869,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -228645,7 +226197,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -228762,11 +226313,6 @@ components: used: 0 remaining: 10 reset: 1691591091 - rate: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1372700873 full-repository-default-response: summary: Default response value: @@ -228859,7 +226405,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true has_discussions: false archived: false disabled: false @@ -236401,25 +233946,6 @@ components: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -237054,25 +234580,6 @@ components: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -237811,26 +235318,6 @@ components: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -238619,520 +236106,500 @@ components: type: User site_admin: true requested_reviewers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - pull-request-simple: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: + draft: false + pull-request-simple: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: - login: other_user id: 1 node_id: MDQ6VXNlcjE= @@ -240435,9 +237902,6 @@ components: patched_versions: 1.0.2 vulnerable_functions: - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H @@ -240623,7 +238087,6 @@ components: patched_versions: 1.0.0 vulnerable_functions: - important_function - cvss: cvss_severities: cvss_v3: cvss_v4: @@ -241206,7 +238669,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -241638,7 +239100,6 @@ components: name: bug color: ff0000 state: open - assignee: milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -242028,7 +239489,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index aa8a24479c..ed5b53dee5 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -522,3173 +522,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -17641,230 +14474,253 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { - "post": { - "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", - "minLength": 1, - "maxLength": 256 - }, - "digest": { - "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", - "minLength": 71, - "maxLength": 71, - "pattern": "^sha256:[a-f0-9]{64}$" - }, - "version": { - "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - }, - "return_records": { - "type": "boolean", - "default": true, - "description": "If true, the endpoint will return the set records in the response body\n" - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + "post": { + "summary": "Set cluster deployment records", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the set records in the response body\n" + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - }, - "required": [ - "total_count" - ] + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" }, "examples": { - "insufficient_repo_permissions": { + "not_found": { "value": { "message": { - "cause": "artifact metadata write permission required on one or more repositories", + "cause": "One or more repositories do not exist", "repositories": [ - 123, - 345 + "repoA", + "repoB" ] } } @@ -17872,9 +14728,6 @@ } } } - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -299002,7 +295855,19 @@ "type": "analyst" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "integration": { "value": { @@ -303095,7 +299960,18 @@ "site_admin": false }, "truncated": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "value": { + "user": null + } + }, + "version": "2026-03-10" + } + ] }, "gitignore-template": { "value": { @@ -310531,130 +307407,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] }, "org-ruleset-items": { "value": [ @@ -311835,7 +308723,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "team-items-response-if-child-teams-exist": { "value": [ @@ -311945,7 +308845,19 @@ "remaining": 4999, "reset": 1372700873 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_rate_limit_rate", + "patch": [ + { + "op": "remove", + "path": "/value/rate" + } + ], + "version": "2026-03-10" + } + ] }, "full-repository-default-response": { "summary": "Default response", @@ -312475,7 +309387,19 @@ } } } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "artifact-paginated": { "value": { @@ -321043,7 +317967,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-comment-items": { "value": [ @@ -321763,7 +318699,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-event-for-issue-items": { "value": [ @@ -322956,7 +319904,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "pull-request-review-comment-items": { "value": [ @@ -324338,7 +321308,29 @@ "author_association": "OWNER", "auto_merge": null, "draft": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "pull-request-review-items": { "value": [ @@ -325689,7 +322681,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "repository-advisory-pvr": { "value": { @@ -325839,7 +322843,19 @@ } ], "private_fork": null - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "simple-user-items-default-response": { "summary": "Default response", @@ -326644,7 +323660,19 @@ "subscribers_count": 42, "network_count": 0 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "public-repository-items": { "value": [ @@ -327036,7 +324064,19 @@ "state_reason": "completed" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/items/0/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-search-result-item-paginated-lexical-fallback": { "summary": "Hybrid search with lexical fallback", @@ -327433,7 +324473,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "private-user-response-with-public-and-private-profile-information": { "summary": "Response with public and private profile information", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index cda1e79ab0..2a96be4a38 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -338,2461 +338,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -13077,7 +10622,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -219365,6 +216922,12 @@ components: type: User site_admin: false type: analyst + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' integration: value: id: 1 @@ -223191,6 +220754,12 @@ components: type: User site_admin: false truncated: false + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + value: + user: + version: '2026-03-10' gitignore-template: value: name: C @@ -229638,6 +227207,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' org-ruleset-items: value: - id: 21 @@ -230608,6 +228183,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' team-items-response-if-child-teams-exist: value: - id: 2 @@ -230698,6 +228279,12 @@ components: used: 1 remaining: 4999 reset: 1372700873 + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + - op: remove + path: "/value/rate" + version: '2026-03-10' full-repository-default-response: summary: Default response value: @@ -231199,6 +228786,12 @@ components: status: disabled secret_scanning_delegated_alert_dismissal: status: disabled + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' artifact-paginated: value: total_count: 2 @@ -238437,6 +236030,12 @@ components: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' issue-comment-items: value: - id: 1 @@ -239090,6 +236689,12 @@ components: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' issue-event-for-issue-items: value: - id: 1 @@ -240150,6 +237755,17 @@ components: additions: 100 deletions: 3 changed_files: 5 + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' pull-request-review-comment-items: value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -241398,6 +239014,17 @@ components: author_association: OWNER auto_merge: draft: false + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' pull-request-review-items: value: - id: 80 @@ -242504,6 +240131,12 @@ components: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' repository-advisory-pvr: value: ghsa_id: GHSA-abcd-1234-efgh @@ -242622,6 +240255,12 @@ components: permission: admin parent: private_fork: + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' simple-user-items-default-response: summary: Default response value: @@ -243266,6 +240905,12 @@ components: allow_forking: true subscribers_count: 42 network_count: 0 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' public-repository-items: value: - id: 1296269 @@ -243619,6 +241264,12 @@ components: locked: true author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/items/0/assignee" + version: '2026-03-10' issue-search-result-item-paginated-lexical-fallback: summary: Hybrid search with lexical fallback description: When a hybrid or semantic search falls back to lexical, the response @@ -243991,6 +241642,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' private-user-response-with-public-and-private-profile-information: summary: Response with public and private profile information value: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index fbe2fddc5e..e2f992321a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -2220,3173 +2220,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -110409,6 +107242,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0038130f72..97c1d1aac3 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -1163,2461 +1163,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -28659,7 +26204,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 6b522064ce..606cf805bb 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -2062,10 +2062,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", @@ -2148,3173 +2144,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -54244,7 +51073,6 @@ "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", @@ -106149,6 +102977,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } @@ -222724,7 +219565,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -248868,7 +245708,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -249930,12 +246769,6 @@ "remaining": 10, "reset": 1691591091 } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 } } } @@ -254304,7 +251137,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "has_discussions": false, "archived": false, "disabled": false, @@ -259427,7 +256259,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -409086,7 +405917,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -431409,26 +428239,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -452995,26 +449805,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -453212,26 +450002,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -457356,26 +454126,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -461477,26 +458227,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -465395,26 +462125,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -475708,26 +472418,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -479797,26 +476487,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -501458,26 +498128,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -506616,26 +503266,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -514614,26 +511244,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -518702,26 +515312,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -556687,27 +553277,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -564718,27 +561287,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -569552,27 +566100,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -587142,27 +583669,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -622478,10 +618984,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -625005,7 +621507,6 @@ ] } ], - "cvss": null, "cvss_severities": { "cvss_v3": null, "cvss_v4": null @@ -627331,10 +623832,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -629913,10 +626410,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -630166,10 +626659,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -635061,7 +631550,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -640817,7 +637305,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -645521,7 +642008,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -654901,7 +651387,6 @@ } ], "state": "open", - "assignee": null, "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -663328,7 +659813,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -718941,7 +715425,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index c08f0e9d97..c20818e6fc 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -1087,2505 +1087,47 @@ paths: vulnerable_version_range: "<=1.0.2" vulnerable_functions: - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-400 - name: Uncontrolled Resource Consumption - credits: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - '404': &6 - description: Resource not found - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + credits: + - user: + login: octocat id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + '404': &6 + description: Resource not found content: application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation + category: security-advisories + subcategory: global-advisories "/app": get: summary: Get the authenticated app @@ -17347,7 +14889,6 @@ paths: updated_at: '2011-06-20T11:34:15Z' description: Hello World Examples comments: 0 - user: comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ owner: login: octocat @@ -28339,7 +25880,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47054,7 +44607,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -53652,7 +51204,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -54045,11 +51596,6 @@ paths: used: 0 remaining: 10 reset: 1691591091 - rate: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1372700873 headers: X-RateLimit-Limit: example: 5000 @@ -54188,7 +51734,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true has_discussions: false archived: false disabled: false @@ -82980,269 +80525,250 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *65 - '301': *329 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - post: - summary: Create an issue - description: |- - Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#create-an-issue - parameters: - - *325 - - *326 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - oneOf: - - type: string - - type: integer - description: The title of the issue. - body: - type: string - description: The contents of the issue. - milestone: - oneOf: - - type: string - - type: integer - description: 'The `number` of the milestone to associate this - issue with. _NOTE: Only users with push access can set the milestone - for new issues. The milestone is silently dropped otherwise._' - type: - - 'null' - - string - - integer - labels: - type: array - description: 'Labels to associate with this issue. _NOTE: Only users - with push access can set labels for new issues. Labels are silently - dropped otherwise._' - items: - oneOf: - - type: string - - type: object - properties: - id: - type: integer - name: - type: string - description: - type: - - string - - 'null' - color: - type: - - string - - 'null' - assignees: - type: array - description: 'Logins for Users to assign to this issue. _NOTE: Only - users with push access can set assignees for new issues. Assignees - are silently dropped otherwise._' - items: - type: string - type: - type: - - string - - 'null' - description: 'The name of the issue type to associate with this - issue. _NOTE: Only users with push access can set the type for - new issues. The type is silently dropped otherwise._' - examples: - - Epic - required: - - title - examples: - default: - value: - title: Found a bug - body: I'm having a problem with this. - assignees: - - octocat - milestone: 1 - labels: - - bug - responses: - '201': - description: Response - content: - application/json: - schema: *81 - examples: - default: &527 - value: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - closed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - author_association: COLLABORATOR - state_reason: completed - headers: + Link: *65 + '301': *329 + '422': *15 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + post: + summary: Create an issue + description: |- + Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#create-an-issue + parameters: + - *325 + - *326 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + oneOf: + - type: string + - type: integer + description: The title of the issue. + body: + type: string + description: The contents of the issue. + milestone: + oneOf: + - type: string + - type: integer + description: 'The `number` of the milestone to associate this + issue with. _NOTE: Only users with push access can set the milestone + for new issues. The milestone is silently dropped otherwise._' + type: + - 'null' + - string + - integer + labels: + type: array + description: 'Labels to associate with this issue. _NOTE: Only users + with push access can set labels for new issues. Labels are silently + dropped otherwise._' + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: + - string + - 'null' + color: + type: + - string + - 'null' + assignees: + type: array + description: 'Logins for Users to assign to this issue. _NOTE: Only + users with push access can set assignees for new issues. Assignees + are silently dropped otherwise._' + items: + type: string + type: + type: + - string + - 'null' + description: 'The name of the issue type to associate with this + issue. _NOTE: Only users with push access can set the type for + new issues. The type is silently dropped otherwise._' + examples: + - Epic + required: + - title + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + labels: + - bug + responses: + '201': + description: Response + content: + application/json: + schema: *81 + examples: + default: &527 + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 schema: @@ -84450,25 +81976,6 @@ paths: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -90804,26 +88311,6 @@ paths: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -93263,26 +90750,6 @@ paths: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -97673,9 +95140,6 @@ paths: patched_versions: 1.0.2 vulnerable_functions: - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H @@ -97998,7 +95462,6 @@ paths: patched_versions: 1.0.0 vulnerable_functions: - important_function - cvss: cvss_severities: cvss_v3: cvss_v4: @@ -99977,7 +97440,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -101556,7 +99018,6 @@ paths: name: bug color: ff0000 state: open - assignee: milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -103389,7 +100850,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index f3aed58b08..c9603aafe6 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -2291,7 +2291,19 @@ "type": "analyst" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -2332,3173 +2344,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -58234,7 +55079,18 @@ "site_admin": false }, "truncated": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "value": { + "user": null + } + }, + "version": "2026-03-10" + } + ] } } } @@ -112448,6 +109304,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } @@ -237220,130 +234089,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] } } } @@ -263342,7 +260223,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -264416,7 +261309,19 @@ "remaining": 4999, "reset": 1372700873 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_rate_limit_rate", + "patch": [ + { + "op": "remove", + "path": "/value/rate" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -269615,7 +266520,19 @@ } } } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -275110,7 +272027,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -427037,130 +423966,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] } } } @@ -449929,7 +446870,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -472593,7 +469546,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } }, "pinned_comment": { @@ -472810,7 +469775,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -477314,7 +474291,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -481807,7 +478796,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -486078,7 +483079,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -497097,7 +494110,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -501539,7 +498564,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -523906,7 +520943,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -529417,7 +526466,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -538121,7 +535182,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -542562,7 +539635,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -582293,7 +579378,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -590859,7 +587966,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -596228,7 +593357,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -614855,7 +612006,29 @@ "author_association": "OWNER", "auto_merge": null, "draft": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -650061,7 +647234,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -652581,7 +649766,19 @@ } ], "private_fork": null - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -655050,7 +652247,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -657700,7 +654909,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "add_credit": { "value": { @@ -657953,7 +655174,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -663493,7 +660726,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -668990,7 +666235,19 @@ "subscribers_count": 42, "network_count": 0 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -674365,7 +671622,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -683766,7 +681035,19 @@ "state_reason": "completed" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/items/0/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "lexical-fallback": { "summary": "Hybrid search with lexical fallback", @@ -692280,7 +689561,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -754177,7 +751470,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 6f5c800113..0b84b8b786 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1204,2471 +1204,22 @@ paths: type: User site_admin: false type: analyst - '404': &6 - description: Resource not found - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' + '404': &6 + description: Resource not found content: application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation + category: security-advisories + subcategory: global-advisories "/app": get: summary: Get the authenticated app @@ -17924,6 +15475,12 @@ paths: type: User site_admin: false truncated: false + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + value: + user: + version: '2026-03-10' headers: Location: example: https://api.github.com/gists/aa5a315d61ae9438b18d @@ -28940,7 +26497,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48261,6 +45830,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -54664,6 +52239,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '204': description: Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the @@ -55040,6 +52621,12 @@ paths: used: 1 remaining: 4999 reset: 1372700873 + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + - op: remove + path: "/value/rate" + version: '2026-03-10' headers: X-RateLimit-Limit: example: 5000 @@ -55587,6 +53174,12 @@ paths: status: disabled secret_scanning_delegated_alert_dismissal: status: disabled + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '403': *27 '404': *6 '301': *329 @@ -84333,6 +81926,12 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 @@ -85656,6 +83255,12 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' '301': *329 '404': *6 '410': *522 @@ -92435,6 +90040,17 @@ paths: additions: 100 deletions: 3 changed_files: 5 + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -94878,6 +92494,17 @@ paths: author_association: OWNER auto_merge: draft: false + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' '422': *15 x-github: githubCloudOnly: false @@ -99034,6 +96661,12 @@ paths: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' '403': *27 '404': *6 '422': *15 @@ -99289,6 +96922,12 @@ paths: permission: admin parent: private_fork: + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' '403': *27 '404': *6 '422': *15 @@ -101329,6 +98968,12 @@ paths: allow_forking: true subscribers_count: 42 network_count: 0 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -102862,6 +100507,12 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/items/0/assignee" + version: '2026-03-10' lexical-fallback: summary: Hybrid search with lexical fallback description: When a hybrid or semantic search falls back to lexical, @@ -104677,6 +102328,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '204': description: Response if repository is managed by this team '404': diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 6da3b03a60..60aebf492c 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -2236,3173 +2236,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -160992,6 +157825,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 9ae0b470a4..b0b5026af1 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -1171,2461 +1171,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -42988,7 +40533,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index b4054fa9b1..5b151658ce 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -2078,10 +2078,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", @@ -2164,3173 +2160,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -106197,7 +103026,6 @@ "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", @@ -156445,6 +153273,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } @@ -280868,7 +277709,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -307889,7 +304729,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -309283,12 +306122,6 @@ "remaining": 10, "reset": 1691591091 } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 } } } @@ -313670,7 +310503,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "has_discussions": false, "archived": false, "disabled": false, @@ -318820,7 +315652,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -474862,7 +471693,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -497225,26 +494055,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -518811,26 +515621,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -519028,26 +515818,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -523172,26 +519942,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -527293,26 +524043,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -531211,26 +527941,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -541524,26 +538234,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -545613,26 +542303,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -567274,26 +563944,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -572432,26 +569082,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -580430,26 +577060,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -584518,26 +581128,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -622622,27 +619212,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -630653,27 +627222,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -635487,27 +632035,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -653101,27 +649628,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -688443,10 +684949,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -690970,7 +687472,6 @@ ] } ], - "cvss": null, "cvss_severities": { "cvss_v3": null, "cvss_v4": null @@ -693296,10 +689797,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -695878,10 +692375,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -696131,10 +692624,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -701038,7 +697527,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -706806,7 +703294,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -711522,7 +708009,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -732383,7 +728869,6 @@ } ], "state": "open", - "assignee": null, "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -740822,7 +737307,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -797096,7 +793580,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 8167021dbe..a00856d730 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -1095,2505 +1095,47 @@ paths: vulnerable_version_range: "<=1.0.2" vulnerable_functions: - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-400 - name: Uncontrolled Resource Consumption - credits: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - '404': &6 - description: Resource not found - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + credits: + - user: + login: octocat id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + '404': &6 + description: Resource not found content: application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation + category: security-advisories + subcategory: global-advisories "/app": get: summary: Get the authenticated app @@ -33241,7 +30783,6 @@ paths: updated_at: '2011-06-20T11:34:15Z' description: Hello World Examples comments: 0 - user: comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ owner: login: octocat @@ -42586,7 +40127,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61848,7 +59401,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -66562,7 +64114,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -67066,11 +64617,6 @@ paths: used: 0 remaining: 10 reset: 1691591091 - rate: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1372700873 headers: X-RateLimit-Limit: example: 5000 @@ -67210,7 +64756,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true has_discussions: false archived: false disabled: false @@ -97009,269 +94554,250 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *45 - '301': *465 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - post: - summary: Create an issue - description: |- - Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. - - This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/create - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue - parameters: - - *459 - - *460 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - oneOf: - - type: string - - type: integer - description: The title of the issue. - body: - type: string - description: The contents of the issue. - milestone: - oneOf: - - type: string - - type: integer - description: 'The `number` of the milestone to associate this - issue with. _NOTE: Only users with push access can set the milestone - for new issues. The milestone is silently dropped otherwise._' - type: - - 'null' - - string - - integer - labels: - type: array - description: 'Labels to associate with this issue. _NOTE: Only users - with push access can set labels for new issues. Labels are silently - dropped otherwise._' - items: - oneOf: - - type: string - - type: object - properties: - id: - type: integer - name: - type: string - description: - type: - - string - - 'null' - color: - type: - - string - - 'null' - assignees: - type: array - description: 'Logins for Users to assign to this issue. _NOTE: Only - users with push access can set assignees for new issues. Assignees - are silently dropped otherwise._' - items: - type: string - type: - type: - - string - - 'null' - description: 'The name of the issue type to associate with this - issue. _NOTE: Only users with push access can set the type for - new issues. The type is silently dropped otherwise._' - examples: - - Epic - required: - - title - examples: - default: - value: - title: Found a bug - body: I'm having a problem with this. - assignees: - - octocat - milestone: 1 - labels: - - bug - responses: - '201': - description: Response - content: - application/json: - schema: *219 - examples: - default: &651 - value: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - closed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - author_association: COLLABORATOR - state_reason: completed - headers: + Link: *45 + '301': *465 + '422': *15 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + post: + summary: Create an issue + description: |- + Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/create + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue + parameters: + - *459 + - *460 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + oneOf: + - type: string + - type: integer + description: The title of the issue. + body: + type: string + description: The contents of the issue. + milestone: + oneOf: + - type: string + - type: integer + description: 'The `number` of the milestone to associate this + issue with. _NOTE: Only users with push access can set the milestone + for new issues. The milestone is silently dropped otherwise._' + type: + - 'null' + - string + - integer + labels: + type: array + description: 'Labels to associate with this issue. _NOTE: Only users + with push access can set labels for new issues. Labels are silently + dropped otherwise._' + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: + - string + - 'null' + color: + type: + - string + - 'null' + assignees: + type: array + description: 'Logins for Users to assign to this issue. _NOTE: Only + users with push access can set assignees for new issues. Assignees + are silently dropped otherwise._' + items: + type: string + type: + type: + - string + - 'null' + description: 'The name of the issue type to associate with this + issue. _NOTE: Only users with push access can set the type for + new issues. The type is silently dropped otherwise._' + examples: + - Epic + required: + - title + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + labels: + - bug + responses: + '201': + description: Response + content: + application/json: + schema: *219 + examples: + default: &651 + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 schema: @@ -98479,25 +96005,6 @@ paths: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -104879,26 +102386,6 @@ paths: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -107338,26 +104825,6 @@ paths: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -111749,9 +109216,6 @@ paths: patched_versions: 1.0.2 vulnerable_functions: - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H @@ -112074,7 +109538,6 @@ paths: patched_versions: 1.0.0 vulnerable_functions: - important_function - cvss: cvss_severities: cvss_v3: cvss_v4: @@ -114053,7 +111516,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -117739,7 +115201,6 @@ paths: name: bug color: ff0000 state: open - assignee: milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -119576,7 +117037,6 @@ paths: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 334b9bec53..52f0592e77 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -2307,7 +2307,19 @@ "type": "analyst" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -2348,3173 +2360,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -110431,7 +107276,18 @@ "site_admin": false }, "truncated": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "value": { + "user": null + } + }, + "version": "2026-03-10" + } + ] } } } @@ -163279,6 +160135,19 @@ "type": "string" } } + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } } } } @@ -295911,130 +292780,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] } } } @@ -322910,7 +319791,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -324316,7 +321209,19 @@ "remaining": 4999, "reset": 1372700873 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_rate_limit_rate", + "patch": [ + { + "op": "remove", + "path": "/value/rate" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -329532,7 +326437,19 @@ } } } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -335050,7 +331967,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -493360,130 +490289,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] } } } @@ -516292,7 +513233,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -538956,7 +535909,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } }, "pinned_comment": { @@ -539173,7 +536138,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -543677,7 +540654,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -548170,7 +545159,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -552441,7 +549442,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -563460,7 +560473,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -567902,7 +564927,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -590269,7 +587306,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -595780,7 +592829,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -604484,7 +601545,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -608925,7 +605998,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -648775,7 +645860,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -657341,7 +654448,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -662710,7 +659839,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -681361,7 +678512,29 @@ "author_association": "OWNER", "auto_merge": null, "draft": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -716573,7 +713746,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -719093,7 +716278,19 @@ } ], "private_fork": null - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -721562,7 +718759,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -724212,7 +721421,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "add_credit": { "value": { @@ -724465,7 +721686,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -730017,7 +727250,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -735526,7 +732771,19 @@ "subscribers_count": 42, "network_count": 0 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -740913,7 +738170,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -761795,7 +759064,19 @@ "state_reason": "completed" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/items/0/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "lexical-fallback": { "summary": "Hybrid search with lexical fallback", @@ -770321,7 +767602,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } @@ -832891,7 +830184,19 @@ "open_issues": 1, "watchers": 1 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] } } } diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 4656d17d7b..6e5f6ebd41 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -1212,2471 +1212,22 @@ paths: type: User site_admin: false type: analyst - '404': &6 - description: Resource not found - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' + '404': &6 + description: Resource not found content: application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation + category: security-advisories + subcategory: global-advisories "/app": get: summary: Get the authenticated app @@ -33818,6 +31369,12 @@ paths: type: User site_admin: false truncated: false + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + value: + user: + version: '2026-03-10' headers: Location: example: https://api.github.com/gists/aa5a315d61ae9438b18d @@ -43282,7 +40839,19 @@ paths: repositories: - 123 - 345 - '404': *6 + '404': + description: Resource not found + content: + application/json: + schema: *3 + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63080,6 +60649,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -67599,6 +65174,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '204': description: Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the @@ -68086,6 +65667,12 @@ paths: used: 1 remaining: 4999 reset: 1372700873 + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + - op: remove + path: "/value/rate" + version: '2026-03-10' headers: X-RateLimit-Limit: example: 5000 @@ -68637,6 +66224,12 @@ paths: status: disabled secret_scanning_delegated_alert_dismissal: status: disabled + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '403': *27 '404': *6 '301': *465 @@ -98387,6 +95980,12 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 @@ -99710,6 +97309,12 @@ paths: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' '301': *465 '404': *6 '410': *646 @@ -106535,6 +104140,17 @@ paths: additions: 100 deletions: 3 changed_files: 5 + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -108978,6 +106594,17 @@ paths: author_association: OWNER auto_merge: draft: false + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' '422': *15 x-github: githubCloudOnly: false @@ -113135,6 +110762,12 @@ paths: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' '403': *27 '404': *6 '422': *15 @@ -113390,6 +111023,12 @@ paths: permission: admin parent: private_fork: + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' '403': *27 '404': *6 '422': *15 @@ -115430,6 +113069,12 @@ paths: allow_forking: true subscribers_count: 42 network_count: 0 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119070,6 +116715,12 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/items/0/assignee" + version: '2026-03-10' lexical-fallback: summary: Hybrid search with lexical fallback description: When a hybrid or semantic search falls back to lexical, @@ -120889,6 +118540,12 @@ paths: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' '204': description: Response if repository is managed by this team '404': diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index ab09db7d52..a496821e24 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -538,3173 +538,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -28525,7 +25358,27 @@ } }, "404": { - "$ref": "#/components/responses/not_found" + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "not_found": { + "value": { + "message": { + "cause": "One or more repositories do not exist", + "repositories": [ + "repoA", + "repoB" + ] + } + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index e93f46a637..4ce4cb5b87 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -346,2461 +346,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -20726,7 +18271,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/ghec/ghec.2026-03-10.json b/descriptions-next/ghec/ghec.2026-03-10.json index 5f0b74ef83..98b7030def 100644 --- a/descriptions-next/ghec/ghec.2026-03-10.json +++ b/descriptions-next/ghec/ghec.2026-03-10.json @@ -538,3173 +538,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -28271,230 +25104,253 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { - "post": { - "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", - "minLength": 1, - "maxLength": 256 - }, - "digest": { - "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", - "minLength": 71, - "maxLength": 71, - "pattern": "^sha256:[a-f0-9]{64}$" - }, - "version": { - "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - }, - "return_records": { - "type": "boolean", - "default": true, - "description": "If true, the endpoint will return the set records in the response body\n" - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + "post": { + "summary": "Set cluster deployment records", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the set records in the response body\n" + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - }, - "required": [ - "total_count" - ] + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" }, "examples": { - "insufficient_repo_permissions": { + "not_found": { "value": { "message": { - "cause": "artifact metadata write permission required on one or more repositories", + "cause": "One or more repositories do not exist", "repositories": [ - 123, - 345 + "repoA", + "repoB" ] } } @@ -28502,9 +25358,6 @@ } } } - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -319997,10 +316850,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", - "score": 7.6 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", @@ -326725,7 +323574,6 @@ "updated_at": "2011-06-20T11:34:15Z", "description": "Hello World Examples", "comments": 0, - "user": null, "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", "owner": { "login": "octocat", @@ -333149,7 +329997,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -334423,7 +331270,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -334576,12 +331422,6 @@ "remaining": 10, "reset": 1691591091 } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 } } }, @@ -334680,7 +331520,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "has_discussions": false, "archived": false, "disabled": false, @@ -343789,26 +340628,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -344509,26 +341328,6 @@ "default": true } ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -345337,27 +342136,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -346736,27 +343514,6 @@ "updated_at": "2011-01-26T19:01:12Z", "closed_at": "2011-01-26T19:01:12Z", "merged_at": "2011-01-26T19:01:12Z", - "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, "assignees": [ { "login": "octocat", @@ -348353,10 +345110,6 @@ ] } ], - "cvss": { - "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", - "score": 9.8 - }, "cvss_severities": { "cvss_v3": { "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", @@ -348578,7 +345331,6 @@ ] } ], - "cvss": null, "cvss_severities": { "cvss_v3": null, "cvss_v4": null @@ -349334,7 +346086,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", @@ -350151,7 +346902,6 @@ } ], "state": "open", - "assignee": null, "milestone": { "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", @@ -350569,7 +347319,6 @@ "has_projects": true, "has_wiki": true, "has_pages": false, - "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", diff --git a/descriptions-next/ghec/ghec.2026-03-10.yaml b/descriptions-next/ghec/ghec.2026-03-10.yaml index b7a047d650..26822556ea 100644 --- a/descriptions-next/ghec/ghec.2026-03-10.yaml +++ b/descriptions-next/ghec/ghec.2026-03-10.yaml @@ -346,2461 +346,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -20711,7 +18256,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -234503,9 +232060,6 @@ components: vulnerable_version_range: "<=1.0.2" vulnerable_functions: - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H @@ -240310,7 +237864,6 @@ components: updated_at: '2011-06-20T11:34:15Z' description: Hello World Examples comments: 0 - user: comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ owner: login: octocat @@ -245804,7 +243357,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -246889,7 +244441,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -247015,11 +244566,6 @@ components: used: 0 remaining: 10 reset: 1691591091 - rate: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1372700873 full-repository-default-response: summary: Default response value: @@ -247113,7 +244659,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true has_discussions: false archived: false disabled: false @@ -254819,25 +252364,6 @@ components: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -255472,25 +252998,6 @@ components: description: Something isn't working color: f29513 default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -256212,26 +253719,6 @@ components: updated_at: '2011-01-26T19:01:12Z' closed_at: '2011-01-26T19:01:12Z' merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false assignees: - login: octocat id: 1 @@ -257020,520 +254507,500 @@ components: type: User site_admin: true requested_reviewers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - pull-request-simple: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: + draft: false + pull-request-simple: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: - login: other_user id: 1 node_id: MDQ6VXNlcjE= @@ -258836,9 +256303,6 @@ components: patched_versions: 1.0.2 vulnerable_functions: - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 cvss_severities: cvss_v3: vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H @@ -259024,7 +256488,6 @@ components: patched_versions: 1.0.0 vulnerable_functions: - important_function - cvss: cvss_severities: cvss_v3: cvss_v4: @@ -259607,7 +257070,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public @@ -260275,7 +257737,6 @@ components: name: bug color: ff0000 state: open - assignee: milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -260665,7 +258126,6 @@ components: has_projects: true has_wiki: true has_pages: false - has_downloads: true archived: false disabled: false visibility: public diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 2f67ba4e54..3960d7365e 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -538,3173 +538,6 @@ } } }, - "/agents/repos/{owner}/{repo}/tasks": { - "get": { - "summary": "List tasks for repository", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks-for-repo", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - }, - { - "name": "creator_id", - "in": "query", - "schema": { - "type": "integer" - }, - "description": "Filter tasks by creator user ID" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - }, - "post": { - "summary": "Create a task", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/create-task", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "prompt" - ], - "properties": { - "prompt": { - "type": "string", - "description": "The user's prompt for the agent" - }, - "model": { - "type": "string", - "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" - }, - "create_pull_request": { - "type": "boolean", - "description": "Whether to create a PR.", - "default": false - }, - "base_ref": { - "type": "string", - "description": "Base ref for new branch/PR" - } - } - }, - "examples": { - "default": { - "value": { - "prompt": "Fix the login button on the homepage", - "base_ref": "main" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Task created successfully", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "queued", - "session_count": 1, - "artifacts": [], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T00:00:00Z" - } - } - } - } - } - }, - "400": { - "description": "Problems parsing JSON", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/repos/{owner}/{repo}/tasks/{task_id}": { - "get": { - "summary": "Get a task by repo", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-repo-and-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The account owner of the repository. The name is not case sensitive." - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The name of the repository. The name is not case sensitive." - }, - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks": { - "get": { - "summary": "List tasks", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/list-tasks", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "per_page", - "in": "query", - "schema": { - "type": "integer", - "default": 30, - "minimum": 1, - "maximum": 100 - }, - "description": "The number of results per page (max 100)." - }, - { - "name": "page", - "in": "query", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - }, - "description": "The page number of the results to fetch." - }, - { - "name": "sort", - "in": "query", - "schema": { - "type": "string", - "default": "updated_at", - "enum": [ - "updated_at", - "created_at" - ] - }, - "description": "The field to sort results by. Can be `updated_at` or `created_at`." - }, - { - "name": "direction", - "in": "query", - "schema": { - "type": "string", - "default": "desc", - "enum": [ - "asc", - "desc" - ] - }, - "description": "The direction to sort results. Can be `asc` or `desc`." - }, - { - "name": "state", - "in": "query", - "schema": { - "type": "string" - }, - "description": "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`." - }, - { - "name": "is_archived", - "in": "query", - "schema": { - "type": "boolean", - "default": false - }, - "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." - }, - { - "name": "since", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" - } - ], - "responses": { - "200": { - "description": "Tasks retrieved successfully", - "headers": { - "Link": { - "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", - "schema": { - "type": "string" - }, - "example": "; rel=\"next\", ; rel=\"first\"" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "tasks" - ], - "properties": { - "tasks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - "description": "List of tasks" - }, - "total_active_count": { - "type": "integer", - "format": "int32", - "description": "Total count of active (non-archived) tasks" - }, - "total_archived_count": { - "type": "integer", - "format": "int32", - "description": "Total count of archived tasks" - } - } - }, - "examples": { - "default": { - "value": { - "tasks": [ - { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Bad request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, - "/agents/tasks/{task_id}": { - "get": { - "summary": "Get a task by ID", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", - "tags": [ - "agent-tasks" - ], - "operationId": "agent-tasks/get-task-by-id", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "agent-tasks", - "subcategory": "agent-tasks" - }, - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The unique identifier of the task." - } - ], - "responses": { - "200": { - "description": "Task retrieved successfully", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Unique task identifier" - }, - "url": { - "type": "string", - "description": "API URL for this task" - }, - "html_url": { - "type": "string", - "description": "Web URL for this task" - }, - "name": { - "type": "string", - "description": "Human-readable name derived from the task prompt" - }, - "creator": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - } - ], - "description": "The entity who created this task" - }, - "creator_type": { - "type": "string", - "description": "Type of the task creator", - "enum": [ - "user", - "organization" - ] - }, - "user_collaborators": { - "type": "array", - "items": { - "type": "object", - "description": "A GitHub user", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "description": "User objects of collaborators on this task", - "deprecated": true - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this task belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "state": { - "type": "string", - "description": "Current state of the task, derived from its most recent session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "session_count": { - "type": "integer", - "format": "int32", - "description": "Number of sessions in this task" - }, - "artifacts": { - "type": "array", - "items": { - "type": "object", - "description": "A resource generated by the task", - "required": [ - "provider", - "type", - "data" - ], - "properties": { - "provider": { - "type": "string", - "enum": [ - "github" - ], - "description": "Provider namespace" - }, - "type": { - "type": "string", - "enum": [ - "pull", - "branch" - ], - "description": "Type of artifact. Available Values: `pull`, `branch`.\n" - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "A GitHub resource (pull request, issue, etc.)", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "GitHub resource ID" - }, - "global_id": { - "type": "string", - "description": "GraphQL global ID" - } - } - }, - { - "type": "object", - "description": "A Git branch reference", - "required": [ - "head_ref", - "base_ref" - ], - "properties": { - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - } - } - } - ], - "description": "Resource data (shape depends on type)" - } - } - }, - "description": "Resources created by this task (PRs, branches, etc.)" - }, - "archived_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp when the task was archived, null if not archived" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of the most recent update" - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp when the task was created" - } - } - }, - { - "type": "object", - "properties": { - "sessions": { - "type": "array", - "items": { - "type": "object", - "description": "Full session details within a task", - "required": [ - "id", - "state", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "description": "Session ID" - }, - "name": { - "type": "string", - "description": "Session name" - }, - "user": { - "description": "The user who created this session", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "owner": { - "description": "The owner of the repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the user" - } - } - }, - "repository": { - "description": "The repository this session belongs to", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The unique identifier of the repository" - } - } - }, - "task_id": { - "type": "string", - "description": "Task ID this session belongs to" - }, - "state": { - "type": "string", - "description": "Current state of a session", - "enum": [ - "queued", - "in_progress", - "completed", - "failed", - "idle", - "waiting_for_user", - "timed_out", - "cancelled" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "description": "Last update timestamp" - }, - "completed_at": { - "type": "string", - "format": "date-time", - "description": "Completion timestamp" - }, - "prompt": { - "type": "string", - "description": "Content of the triggering event" - }, - "head_ref": { - "type": "string", - "description": "Head branch name" - }, - "base_ref": { - "type": "string", - "description": "Base branch name" - }, - "model": { - "type": "string", - "description": "Model used for this session" - }, - "error": { - "type": "object", - "description": "Error details for a failed session", - "properties": { - "message": { - "type": "string", - "description": "Error message" - } - } - } - } - }, - "description": "Sessions associated with this task" - } - } - } - ] - }, - "examples": { - "default": { - "value": { - "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "creator": { - "id": 1 - }, - "creator_type": "user", - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "state": "completed", - "session_count": 1, - "artifacts": [ - { - "provider": "github", - "type": "pull", - "data": { - "id": 42 - } - } - ], - "archived_at": null, - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "sessions": [ - { - "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", - "name": "Fix the login button on the homepage", - "user": { - "id": 1 - }, - "owner": { - "id": 1 - }, - "repository": { - "id": 1296269 - }, - "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "state": "completed", - "created_at": "2025-01-01T00:00:00Z", - "updated_at": "2025-01-01T01:00:00Z", - "completed_at": "2025-01-01T01:00:00Z", - "prompt": "Fix the login button on the homepage", - "head_ref": "copilot/fix-1", - "base_ref": "main", - "model": "claude-sonnet-4.6" - } - ] - } - } - } - } - } - }, - "400": { - "description": "Problems parsing request", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "401": { - "description": "Authentication required", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "403": { - "description": "Insufficient permissions", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "type": "object", - "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string", - "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "description": "A single validation error", - "required": [ - "code" - ], - "properties": { - "code": { - "type": "string", - "enum": [ - "missing", - "missing_field", - "invalid", - "already_exists", - "unprocessable", - "custom" - ], - "description": "Machine-readable error code" - }, - "message": { - "type": "string", - "description": "Human-readable message (populated when code is \"custom\")" - } - } - }, - "description": "List of validation errors (present only for 422 responses)" - }, - "documentation_url": { - "type": "string", - "description": "URL to relevant API documentation" - } - } - } - } - } - } - } - } - }, "/app": { "get": { "summary": "Get the authenticated app", @@ -28364,230 +25197,253 @@ } }, "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "orgs", - "subcategory": "artifact-metadata" - } - } - }, - "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { - "post": { - "summary": "Set cluster deployment records", - "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-cluster-deployment-records", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "name": "cluster", - "in": "path", - "description": "The cluster name.", - "required": true, - "schema": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "^[a-zA-Z0-9._-]+$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "logical_environment": { - "type": "string", - "description": "The stage of the deployment.", - "minLength": 1, - "maxLength": 128 - }, - "physical_environment": { - "type": "string", - "description": "The physical region of the deployment.", - "maxLength": 128 - }, - "deployments": { - "type": "array", - "description": "The list of deployments to record.", - "maxItems": 1000, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", - "minLength": 1, - "maxLength": 256 - }, - "digest": { - "type": "string", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", - "minLength": 71, - "maxLength": 71, - "pattern": "^sha256:[a-f0-9]{64}$" - }, - "version": { - "type": "string", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", - "maxLength": 100, - "x-multi-segment": true, - "examples": [ - "1.2.3" - ] - }, - "status": { - "type": "string", - "description": "The deployment status of the artifact.", - "default": "deployed", - "enum": [ - "deployed", - "decommissioned" - ] - }, - "deployment_name": { - "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", - "minLength": 1, - "maxLength": 256 - }, - "github_repository": { - "type": "string", - "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", - "maxLength": 100, - "pattern": "^[A-Za-z0-9.\\-_]+$", - "examples": [ - "my-github-repo" - ] - }, - "tags": { - "type": "object", - "description": "Key-value pairs to tag the deployment record.", - "additionalProperties": { - "type": "string" - } - }, - "runtime_risks": { - "type": "array", - "description": "A list of runtime risks associated with the deployment.", - "maxItems": 4, - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "critical-resource", - "internet-exposed", - "lateral-movement", - "sensitive-data" - ] - } - } - }, - "required": [ - "name", - "deployment_name", - "digest" - ] - } - }, - "return_records": { - "type": "boolean", - "default": true, - "description": "If true, the endpoint will return the set records in the response body\n" - } - }, - "required": [ - "logical_environment", - "deployments" - ] - }, - "examples": { - "default": { - "value": { - "logical_environment": "prod", - "physical_environment": "pacific-east", - "deployments": [ - { - "name": "awesome-image", - "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", - "version": "2.1.0", - "status": "deployed", - "deployment_name": "deployment-pod", - "tags": { - "runtime-risk": "sensitive-data" - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Deployment records created or updated successfully.\n", + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + "post": { + "summary": "Set cluster deployment records", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "maxLength": 100, + "x-multi-segment": true, + "examples": [ + "1.2.3" + ] + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "examples": [ + "my-github-repo" + ] + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the set records in the response body\n" + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "total_count": { - "description": "The number of deployment records created", - "type": "integer" - }, - "deployment_records": { - "type": "array", - "items": { - "$ref": "#/components/schemas/artifact-deployment-record" - } - } - }, - "required": [ - "total_count" - ] + "$ref": "#/components/schemas/basic-error" }, "examples": { - "default": { - "$ref": "#/components/examples/artifact-deployment-record-list" + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/basic-error" }, "examples": { - "insufficient_repo_permissions": { + "not_found": { "value": { "message": { - "cause": "artifact metadata write permission required on one or more repositories", + "cause": "One or more repositories do not exist", "repositories": [ - 123, - 345 + "repoA", + "repoB" ] } } @@ -28595,9 +25451,6 @@ } } } - }, - "404": { - "$ref": "#/components/responses/not_found" } }, "x-github": { @@ -322829,7 +319682,19 @@ "type": "analyst" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "integration": { "value": { @@ -329535,7 +326400,18 @@ "site_admin": false }, "truncated": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "value": { + "user": null + } + }, + "version": "2026-03-10" + } + ] }, "gitignore-template": { "value": { @@ -336234,130 +333110,142 @@ "forks": 1, "open_issues": 1, "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "allow_auto_merge": false, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "version": "2026-03-10" } - } + ] }, "org-ruleset-items": { "value": [ @@ -337257,7 +334145,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "group-mapping": { "value": { @@ -337383,7 +334283,19 @@ "remaining": 4999, "reset": 1372700873 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_rate_limit_rate", + "patch": [ + { + "op": "remove", + "path": "/value/rate" + } + ], + "version": "2026-03-10" + } + ] }, "full-repository-default-response": { "summary": "Default response", @@ -337918,7 +334830,19 @@ } } } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "artifact-paginated": { "value": { @@ -346702,7 +343626,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-comment-items": { "value": [ @@ -347422,7 +344358,19 @@ }, "author_association": "COLLABORATOR", "state_reason": "completed" - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-event-for-issue-items": { "value": [ @@ -348581,7 +345529,29 @@ "additions": 100, "deletions": 3, "changed_files": 5 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "pull-request-review-comment-items": { "value": [ @@ -349963,7 +346933,29 @@ "author_association": "OWNER", "auto_merge": null, "draft": false - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/value/merge_commit_sha" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "pull-request-review-items": { "value": [ @@ -351314,7 +348306,19 @@ "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "repository-advisory-pvr": { "value": { @@ -351464,7 +348468,19 @@ } ], "private_fork": null - } + }, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/value/cvss" + } + ], + "version": "2026-03-10" + } + ] }, "simple-user-items-default-response": { "summary": "Default response", @@ -352269,7 +349285,19 @@ "subscribers_count": 42, "network_count": 0 } - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "public-repository-items": { "value": [ @@ -353006,7 +350034,19 @@ "state_reason": "completed" } ] - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": [ + { + "op": "remove", + "path": "/value/items/0/assignee" + } + ], + "version": "2026-03-10" + } + ] }, "issue-search-result-item-paginated-lexical-fallback": { "summary": "Hybrid search with lexical fallback", @@ -353403,7 +350443,19 @@ "forks": 1, "open_issues": 1, "watchers": 1 - } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": [ + { + "op": "remove", + "path": "/value/has_downloads" + } + ], + "version": "2026-03-10" + } + ] }, "group-mapping-2": { "value": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 8b3bea680e..6c32c6c157 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -346,2461 +346,6 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: '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`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest//rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: - - string - - 'null' - format: date-time - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation "/app": get: summary: Get the authenticated app @@ -20765,7 +18310,19 @@ paths: - 123 - 345 '404': - "$ref": "#/components/responses/not_found" + description: Resource not found + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + not_found: + value: + message: + cause: One or more repositories do not exist + repositories: + - repoA + - repoB x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -236488,6 +234045,12 @@ components: type: User site_admin: false type: analyst + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' integration: value: id: 1 @@ -242283,6 +239846,12 @@ components: type: User site_admin: false truncated: false + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + value: + user: + version: '2026-03-10' gitignore-template: value: name: C @@ -248153,6 +245722,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' org-ruleset-items: value: - id: 21 @@ -248879,6 +246454,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' group-mapping: value: groups: @@ -248978,6 +246559,12 @@ components: used: 1 remaining: 4999 reset: 1372700873 + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + - op: remove + path: "/value/rate" + version: '2026-03-10' full-repository-default-response: summary: Default response value: @@ -249483,6 +247070,12 @@ components: status: disabled secret_scanning_delegated_alert_dismissal: status: disabled + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' artifact-paginated: value: total_count: 2 @@ -256882,6 +254475,12 @@ components: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' issue-comment-items: value: - id: 1 @@ -257535,6 +255134,12 @@ components: site_admin: false author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' issue-event-for-issue-items: value: - id: 1 @@ -258578,6 +256183,17 @@ components: additions: 100 deletions: 3 changed_files: 5 + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' pull-request-review-comment-items: value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -259826,6 +257442,17 @@ components: author_association: OWNER auto_merge: draft: false + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + - op: remove + path: "/value/merge_commit_sha" + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/assignee" + version: '2026-03-10' pull-request-review-items: value: - id: 80 @@ -260932,6 +258559,12 @@ components: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' repository-advisory-pvr: value: ghsa_id: GHSA-abcd-1234-efgh @@ -261050,6 +258683,12 @@ components: permission: admin parent: private_fork: + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + - op: remove + path: "/value/cvss" + version: '2026-03-10' simple-user-items-default-response: summary: Default response value: @@ -261694,6 +259333,12 @@ components: allow_forking: true subscribers_count: 42 network_count: 0 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' public-repository-items: value: - id: 1296269 @@ -262283,6 +259928,12 @@ components: locked: true author_association: COLLABORATOR state_reason: completed + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + - op: remove + path: "/value/items/0/assignee" + version: '2026-03-10' issue-search-result-item-paginated-lexical-fallback: summary: Hybrid search with lexical fallback description: When a hybrid or semantic search falls back to lexical, the response @@ -262655,6 +260306,12 @@ components: forks: 1 open_issues: 1 watchers: 1 + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + - op: remove + path: "/value/has_downloads" + version: '2026-03-10' group-mapping-2: value: groups: