feat: Add agent tasks API support by danyalahmed1995 · Pull Request #4225 · google/go-github

danyalahmed1995 · 2026-05-14T21:30:35Z

Summary

Adds typed client support for GitHub's Agent Tasks REST API.

This implements the documented public-preview Agent Tasks endpoints:

GET /agents/repos/{owner}/{repo}/tasks
POST /agents/repos/{owner}/{repo}/tasks
GET /agents/repos/{owner}/{repo}/tasks/{task_id}
GET /agents/tasks
GET /agents/tasks/{task_id}

Closes #4213.

Changes

Added AgentTasksService and registered it on Client.
Added Agent Tasks request/response types for tasks, sessions, artifacts, list options, and create options.
Added methods for listing, creating, and retrieving agent tasks.
Added tests covering:
- endpoint paths
- HTTP methods
- request bodies
- response parsing
- query parameters
- pagination
- preview API headers
Added OpenAPI operation metadata for the new preview endpoints.
Regenerated accessors and iterators.

Notes

The Agent Tasks API is currently in public preview, so this PR keeps the implementation scoped to the fields and endpoints currently documented by GitHub.

Validation

Ran the repository validation flow from CONTRIBUTING.md:

script/fmt.sh
script/test.sh ./...
script/lint.sh
script/generate.sh
git diff --check

script/test.sh with the default race configuration could not run on this Windows machine because cgo/gcc was not available. I reran the full test script with the non-race fallback across all modules, and it passed.

codecov · 2026-05-14T21:57:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.76%. Comparing base (40ed57f) to head (738801b).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4225      +/-   ##
==========================================
+ Coverage   97.75%   97.76%   +0.01%     
==========================================
  Files         189      190       +1     
  Lines       19035    19133      +98     
==========================================
+ Hits        18608    18706      +98     
  Misses        231      231              
  Partials      196      196

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Thank you, @danyalahmed1995!
Just a couple tweaks/questions, then we should be ready for a second LGTM+Approval from any other contributor to this repo before merging.

cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra - @munlicode

Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

danyalahmed1995 · 2026-05-14T23:06:00Z

@gmlewis Thanks, sounds good. I’ll address the review comments and push an update shortly.

gmlewis

Thank you, @danyalahmed1995!
LGTM.

cc: @stevehipwell - @alexandear - @zyfy29 - @Not-Dhananjay-Mishra - @munlicode

stevehipwell

Thanks for the PR @danyalahmed1995, I've added a couple of comments.

stevehipwell · 2026-05-15T08:35:02Z

+type AgentTasksService service
+
+// AgentTask represents a Copilot cloud agent task.
+type AgentTask struct {


This struct doesn't look correct to me as a number of these fields are required so shouldn't be pointers.

Thanks, I’ll review the documented required vs nullable fields and adjust the struct so required fields are non-pointers while keeping nullable/optional fields as pointers.

stevehipwell · 2026-05-15T08:37:03Z

+	return s.list(ctx, "agents/tasks", opts)
+}
+
+func (s *AgentTasksService) list(ctx context.Context, u string, opts *AgentTaskListOptions) (*AgentTaskList, *Response, error) {


Why is this separate to List?

This was split out only to make the addOptions error path testable after Codecov flagged it. I agree it adds some unnecessary indirection, so I can fold it back into List and drop that extra helper if that’s preferred.

stevehipwell · 2026-05-15T08:38:24Z

+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest(ctx, "GET", u, nil, WithVersion("2026-03-10"))


Could we get "2026-03-10" made into a constant?

Yes, makes sense. I’ll move the preview API version into a package-level constant and use it across the Agent Tasks methods.

alexandear · 2026-05-15T10:48:48Z

+
+// ListByRepo lists tasks for a repository.
+//
+// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#list-tasks-for-repository


Suggested change

// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#list-tasks-for-repository

// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2026-03-10#list-tasks-for-repository

Because below you have:

req, err := s.client.NewRequest(ctx, "GET", u, nil, WithVersion("2026-03-10"))

alexandear · 2026-05-15T10:49:33Z

+// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#start-a-task
+//
+//meta:operation POST /agents/repos/{owner}/{repo}/tasks
+func (s *AgentTasksService) Create(ctx context.Context, owner, repo string, opts *CreateAgentTaskOptions) (*AgentTask, *Response, error) {
+	u := fmt.Sprintf("agents/repos/%v/%v/tasks", owner, repo)
+
+	req, err := s.client.NewRequest(ctx, "POST", u, opts, WithVersion("2026-03-10"))


The versions in the comment and the code do not match.

alexandear · 2026-05-15T10:49:41Z

+// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#get-a-task-by-repo
+//
+//meta:operation GET /agents/repos/{owner}/{repo}/tasks/{task_id}
+func (s *AgentTasksService) GetByRepoAndID(ctx context.Context, owner, repo, taskID string) (*AgentTask, *Response, error) {
+	u := fmt.Sprintf("agents/repos/%v/%v/tasks/%v", owner, repo, taskID)
+
+	req, err := s.client.NewRequest(ctx, "GET", u, nil, WithVersion("2026-03-10"))


The versions in the comment and the code do not match.

alexandear · 2026-05-15T10:49:58Z

+// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#list-tasks
+//
+//meta:operation GET /agents/tasks
+func (s *AgentTasksService) List(ctx context.Context, opts *AgentTaskListOptions) (*AgentTaskList, *Response, error) {
+	return s.list(ctx, "agents/tasks", opts)
+}
+
+func (s *AgentTasksService) list(ctx context.Context, u string, opts *AgentTaskListOptions) (*AgentTaskList, *Response, error) {
+	u, err := addOptions(u, opts)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	req, err := s.client.NewRequest(ctx, "GET", u, nil, WithVersion("2026-03-10"))


The versions in the comment and the code do not match.

alexandear · 2026-05-15T10:50:05Z

+// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#get-a-task-by-id
+//
+//meta:operation GET /agents/tasks/{task_id}
+func (s *AgentTasksService) Get(ctx context.Context, taskID string) (*AgentTask, *Response, error) {
+	u := fmt.Sprintf("agents/tasks/%v", taskID)
+
+	req, err := s.client.NewRequest(ctx, "GET", u, nil, WithVersion("2026-03-10"))


The versions in the comment and the code do not match.

github: add agent tasks API support

8d3c4df

This was referenced May 14, 2026

Add support for new agent tasks REST API #4213

Open

Add support for getting a GitHub App enterprise installation #4212

Open

gmlewis changed the title ~~github: add agent tasks API support~~ feat: Add agent tasks API support May 14, 2026

gmlewis reviewed May 14, 2026

View reviewed changes

Comment thread openapi_operations.yaml Outdated

gmlewis mentioned this pull request May 14, 2026

chore: Update openapi_operations.yaml #4228

Merged

gmlewis added the NeedsReview PR is awaiting a review before merging. label May 14, 2026

danyalahmed1995 added 2 commits May 15, 2026 03:10

Merge remote-tracking branch 'upstream/master' into add-agent-tasks-api

efa12d7

test: cover agent tasks list options error

4263d58

gmlewis requested changes May 14, 2026

View reviewed changes

Comment thread github/agent_tasks.go

Comment thread github/agent_tasks.go Outdated

Update github/agent_tasks.go

43387ee

Co-authored-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

danyalahmed1995 added 2 commits May 15, 2026 05:10

fix: address agent tasks review comments

3c4d321

fix: remove openapi operations diff

93e009c

gmlewis reviewed May 15, 2026

View reviewed changes

Comment thread github/agent_tasks.go Outdated

fix: restore agent tasks creator id type

738801b

gmlewis approved these changes May 15, 2026

View reviewed changes

stevehipwell suggested changes May 15, 2026

View reviewed changes

alexandear suggested changes May 15, 2026

View reviewed changes

	// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2022-11-28#list-tasks-for-repository
	// GitHub API docs: https://docs.github.com/rest/agent-tasks/agent-tasks?apiVersion=2026-03-10#list-tasks-for-repository

Conversation

danyalahmed1995 commented May 14, 2026

Summary

Changes

Notes

Validation

Uh oh!

Uh oh!

codecov Bot commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

danyalahmed1995 commented May 14, 2026

Uh oh!

Uh oh!

gmlewis left a comment

Choose a reason for hiding this comment

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented May 14, 2026 •

edited

Loading