Die Verwendung des Copilot-Cloud-Agents über die API

Sie können Aufgaben programmgesteuert mithilfe der REST-API starten und verwalten Copilot-Cloud-Agent .

Wer kann dieses Feature verwenden?

Organisationen und Unternehmen mit einem Copilot Business- oder Copilot Enterprise-Plan.

In diesem Artikel

Hinweis

Die Agentaufgaben-API befindet sich in öffentliche Vorschau und kann geändert werden.

Sie können die Agentaufgaben-API verwenden, um Cloud-Agent in Ihre eigenen Tools und Workflows zu integrieren. Sie können z. B. eine neue Aufgabe starten, vorhandene Aufgaben auflisten oder den Status einer Aufgabe überprüfen.

Die vollständige API-Referenz finden Sie unter REST-API-Endpunkte für Agentaufgaben.

Authentifizierung

Die Agentaufgaben-API unterstützt nur Benutzer-zu-Server-Token. Sie können sich mit einem personal access tokenToken, einem OAuth app Token oder einem GitHub App Benutzer-zu-Server-Token authentifizieren.

Server-zu-Server-Token, wie GitHub App Installationszugriffstoken, werden nicht unterstützt.

Starten einer Aufgabe über die API

Um eine neue Cloud-Agent Aufgabe zu starten, senden Sie eine POST Anforderung an /agents/repos/{owner}/{repo}/tasks. Der einzige erforderliche Parameter ist prompt, bei dem es sich um die Aufforderung für den Agent handelt.

Shell
curl -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  https://api.github.com/agents/repos/OWNER/REPO/tasks \
  -d '{
    "prompt": "Fix the login button on the homepage",
    "base_ref": "main"
  }'

Ersetzen Sie die folgenden Platzhalterwerte:

  • YOUR-TOKEN: Ein personal access token- oder GitHub App-Benutzer-zu-Server-Token.
  • OWNER: Der Kontobesitzer des Repositorys.
  • REPO: Der Name des Repositorys.

Sie können auch die folgenden optionalen Parameter in den Anforderungstext einschließen:

  • base_ref: Der Basiszweig für die neue Verzweigung und Pull-Request.
  • model: Das KI-Modell, das für die Aufgabe verwendet werden soll. Wenn nicht angegeben, wird Automatische Modellauswahl verwendet. Weitere Informationen zu unterstützten Modellen finden Sie unter REST-API-Endpunkte für Agentaufgaben.
  • create_pull_request: Ein boolescher Wert, der bestimmt, ob eine Pullanforderung für die Aufgabe erstellt werden soll.

Auflisten von Aufgaben

Sie können Aufgaben für ein bestimmtes Repository oder für alle Repositorys auflisten, auf die Sie Zugriff haben.

So listen Sie Aufgaben für ein bestimmtes Repository auf:

Shell
curl -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  https://api.github.com/agents/repos/OWNER/REPO/tasks

So listen Sie Ihre Aufgaben in allen Repositorys auf:

Shell
curl -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  https://api.github.com/agents/tasks

Überprüfen des Status eines Vorgangs

Um den Status einer bestimmten Aufgabe zu überprüfen, senden Sie eine GET Anforderung mit der Aufgaben-ID:

Shell
curl -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  -H "Authorization: Bearer YOUR-TOKEN" \
  https://api.github.com/agents/repos/OWNER/REPO/tasks/TASK-ID

Ersetzen Sie sie TASK-ID durch die ID der Aufgabe, die Sie überprüfen möchten. Sie können diese ID aus der Antwort abrufen, wenn Sie eine Aufgabe oder Listenaufgaben erstellen. Die Antwort enthält den aktuellen state Vorgang, der eine von: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out oder cancelled sein kann.

Weiterführende Lektüre