GitHub Copilot、cloud agent タスクを REST API で起動

367文字
2分
編集

Copilot Business と Copilot Enterprise の利用者向けに、Copilot cloud agent のタスクをプログラムから起動する Agent tasks REST API が public preview で公開された。エージェントは専用の開発環境でバックグラウンド動作し、コード変更の作成と検証のあと pull request を開く。起動後は同じ API で進捗を追跡できる。

  • 利用条件: Copilot Business または Copilot Enterprise の契約(POST /agents/repos/{owner}/{repo}/tasks はこの条件に限定)
  • 認証: クラシック PAT、fine-grained PAT、OAuth トークン。fine-grained ではリポジトリの Agent tasks 権限が必要(起動は read and write、一覧・取得は read)
  • 今後の予定: GitHub App の installation access token、Copilot Pro と Pro+ からの利用は順次対応予定。現時点では GitHub App installation access token は各エンドポイントで未対応
  • リクエスト例: prompt(必須)、任意の modelcreate_pull_requestbase_ref。API バージョンは X-GitHub-Api-Version: 2026-03-10 を指定

タスク起動の主なエンドポイントは POST /agents/repos/{owner}/{repo}/tasks である。リポジトリ単位の一覧は GET /agents/repos/{owner}/{repo}/tasks、認証ユーザー横断の一覧は GET /agents/tasks、個別取得は GET /agents/tasks/{task_id} または GET /agents/repos/{owner}/{repo}/tasks/{task_id} で行う。タスクの state は queued、in_progress、completed、failed、idle、waiting_for_user、timed_out、cancelled を取り、成果物として pull request や branch を artifacts に含められる。

社内の開発者ポータルからリポジトリを一括作成する、複数リポジトリへのリファクタやマイグレーションをスクリプトで並列起動する、週次リリース準備とリリースノート作成を自動化する、といったカスタム自動化への組み込みが想定されている。

#参考文献