Passer au contenu principal
GET
/
agent
/
{projectId}
/
job
/
{id}
Obtenir le job d’agent par identifiant
curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "status": "pending",
      "priority": "high",
      "id": "<string>"
    }
  ],
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

​
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

Votre ID de projet. Peut être copié 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

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

​
sessionId
string

Le sous-domaine auquel appartient cette session.

​
subdomain
string

Le sous-domaine auquel cette session appartient.

​
branch
string | null

Nom de la branche Git dans laquelle les modifications ont été effectuées.

​
haulted
boolean

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

​
haultReason
enum<string>

Motif d’arrêt de la session.

Options disponibles:
completed,
github_missconfigured,
error
​
pullRequestLink
string

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

​
messageToUser
string

Message destiné à l’utilisateur concernant le résultat de la session.

​
todos
object[]

Liste des tâches issues de la session.

​
userId
string

L’ID de l’utilisateur qui a créé cette session, s’il est disponible.

​
title
string

Un titre généré qui résume la tâche de l’agent.

​
createdAt
string<date-time>

Horodatage de la création de la session.