Passer au contenu principal
POST
/
v2
/
agent
/
{projectId}
/
job
Créer une tâche d’agent
curl --request POST \
  --url https://api.mintlify.com/v2/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>"
}
'
{
  "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"
}
Ce point de terminaison crée une tâche d’agent en arrière-plan. La tâche s’exécute de manière asynchrone — utilisez le point de terminaison récupérer une tâche d’agent pour vérifier régulièrement les mises à jour de statut. Si l’agent modifie les fichiers avec succès, une pull request (demande de fusion) est automatiquement créée et le champ prLink est renseigné dans la réponse de la tâche.

​
Limites d’utilisation

  • 100 utilisations par projet Mintlify et par heure

​
Utilisation

curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \
  -H "Authorization: Bearer mint_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Add a quickstart guide for the Python SDK"}'

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.

Corps

application/json
​
prompt
string
requis

L’instruction que l’agent doit exécuter.

Minimum string length: 1

Réponse

Tâche d’agent créée 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). 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.

​
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.