Obtenir une tâche d’agent (v1)

Obsolète. Récupérez le statut et les détails d’une tâche d’agent spécifique, y compris sa progression, les informations de branche et les détails de la pull request.

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

Récupérer une tâche d’agent par ID (v1)

cURL

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

200

{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Ce point de terminaison est obsolète. Utilisez plutôt le point de terminaison v2 get agent job.

​

Utilisation

Ce point de terminaison récupère les détails et l’état d’une tâche d’agent spécifique à partir de son identifiant unique. Utilisez-le pour vérifier la progression, l’état et les résultats d’une tâche d’agent créée précédemment.

​

Détails du job

La réponse inclut des informations telles que :

• Statut d’exécution du job et état d’achèvement
• Informations sur la branche et détails du pull request (demande de fusion)
• metadata de session et horodatages

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écupérer.

Réponse

200 - application/json

Détails de la tâche d’agent récupérés avec succès

sessionId · string

Le sous-domaine auquel cette session appartient.

subdomain · string

Le sous-domaine auquel cette session appartient.

branch · string | null

Nom de la branche Git où les modifications ont été effectuées.

haulted · boolean

Indique si l’exécution de la session a été interrompue.

haultReason · enum<string>

Motif de l’interruption de la session.

Options disponibles: completed, github_missconfigured, error

pullRequestLink · string

Lien vers la pull request (demande de fusion) créée.

messageToUser · string

Message destiné à l’utilisateur concernant l’issue de la session.

todos · object[]

Liste des éléments de la liste de tâches de la session.

Show child attributes

userId · string

ID de l’utilisateur ayant créé cette session, si disponible.

title · string

Titre généré résumant la tâche de l’agent.

createdAt · string<date-time>

Horodatage de création de la session.