Récupérer une tâche d’agent

Récupérez le statut et les détails d’une tâche d’agent, y compris sa progression et le lien vers la pull request (demande de fusion).

GET /v2/agent/{projectId}/job/{id}

Récupérer une tâche d’agent

cURL

curl --request GET \
  --url https://api.mintlify.com/v2/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "status": "active",
  "source": {
    "repository": "<string>",
    "ref": "<string>"
  },
  "model": "<string>",
  "prLink": "https://github.com/org/repo/pull/123",
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}

Interrogez régulièrement ce point de terminaison pour suivre la progression d’une tâche d’agent. Le champ status passe de active à completed ou failed.

Une fois que l’agent a créé une pull request (demande de fusion), le champ prLink est renseigné.

Autorisations

Authorization · string · header · requis

L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé API d’administrateur (préfixée par mint_). Il s’agit d’une clé secrète côté serveur. Générez-en une sur la page des clés API dans votre Dashboard Mintlify.

Paramètres de chemin

projectId · string · requis

L’ID de votre projet. Vous pouvez le copier depuis la page API keys de votre Dashboard.

id · string · requis

L’identifiant unique de la tâche d’agent.

Réponse

200

application/json

Détails de la tâche d’agent

id · string

Identifiant unique de la tâche d’agent.

status · enum<string>

Statut actuel de la tâche. active — l’agent traite actuellement le prompt. completed — l’agent a terminé avec succès et une PR a peut-être été créée (vérifiez prLink). failed — l’agent a rencontré une erreur irrécupérable. Interrogez régulièrement jusqu’à ce que le statut soit completed ou failed.

Options disponibles: active, completed, failed

source · object

Informations sur le référentiel source.

Afficher attributs enfants

model · string

Modèle d’IA utilisé pour cette tâche.

prLink · string<uri> | null

URL de la pull request (demande de fusion) GitHub créée par l’agent. null tant que la tâche est active ou si aucun fichier n’a été modifié. Renseignée une fois que l’agent a créé une PR avec succès.

Exemple:

"https://github.com/org/repo/pull/123"

createdAt · string<date-time>

Horodatage de création de la tâche.

archivedAt · string<date-time> | null

Horodatage d’archivage de la tâche.