curl -X GET 'https://api.github.com/agents/tasks/task-id' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10'

# GET /agents/tasks/{task_id} (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Last verified: 2026-10-20

> Get a task by ID

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X GET 'https://api.github.com/agents/tasks/task-id' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| task_id | path | string | Yes | The unique identifier of the task. |

## Response example
{"id":"string","url":"string"}

---
Need an API key? Get one at https://github.com/settings/tokens

GET

GET /agents/tasks/{task_id} — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Get a task by ID

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 160 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X GET 'https://api.github.com/agents/tasks/task-id' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10'

Parameters

Name	In	Type	Required	Description
task_id	path	string	Yes	The unique identifier of the task.

Response 200 OK

{
  "id": "string",
  "url": "string",
  "html_url": "string",
  "name": "string",
  "creator": {
    "id": 0
  },
  "creator_type": "user",
  "user_collaborators": [
    {
      "id": 0
    }
  ],
  "owner": {
    "id": 0
  },
  "repository": {
    "id": 0
  },
  "state": "queued",
  "session_count": 0,
  "artifacts": [
    {
      "provider": "github",
      "type": "pull",
      "data": {
        "id": 0,
        "global_id": "string"
      }
    }
  ],
  "archived_at": "2026-09-03T00:00:00Z",
  "updated_at": "2026-09-03T00:00:00Z",
  "created_at": "2026-09-03T00:00:00Z",
  "custom_agent": {
    "id": "string"
  },
  "sessions": [
    {
      "id": "string",
      "name": "string",
      "user": {
        "id": 0
      },
      "owner": {
        "id": 0
      },
      "repository": {
        "id": 0
      },
      "task_id": "string",
      "state": "queued",
      "created_at": "2026-09-03T00:00:00Z",
      "updated_at": "2026-09-03T00:00:00Z",
      "completed_at": "2026-09-03T00:00:00Z",
      "prompt": "string",
      "head_ref": "string",
      "base_ref": "string",
      "model": "string",
      "usage": {
        "type": "ai_credits",
        "amount": 0
      },
      "error": {
        "message": "string"
      }
    }
  ]
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.