Envoyer un message de suivi

Envoyer un message de suivi à une tâche d’agent existante afin de fournir des instructions supplémentaires.

POST /v2/agent/{projectId}/job/{id}/message

Envoyer un message de suivi

cURL

curl --request POST \
  --url https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>"
}
'

200

{
  "id": "<string>",
  "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"
}

Envoyez une instruction de suivi à une tâche d’agent existante. Le message est traité de façon asynchrone — interrogez le point de terminaison récupérer la tâche d’agent pour suivre sa progression.

​

Limites de débit

• 100 utilisations par projet Mintlify par heure

​

Utilisation

curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job/{id}/message \
  -H "Authorization: Bearer mint_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Also add error handling examples to the quickstart guide"}'

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 à laquelle envoyer un message.

Corps

application/json

prompt · string · requis

L’instruction de suivi destinée à l’agent.

Minimum string length: 1

Réponse

200

application/json

Message envoyé avec succès

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). archived — la tâche a été archivée. failed — l’agent a rencontré une erreur non récupérable. Interrogez régulièrement jusqu’à ce que le statut soit completed, archived ou failed.

Options disponibles: active, completed, archived, failed

source · object

Informations sur le référentiel source.

Show child attributes

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.