Créer une tâche d’agent (v1)

Obsolète. Créer une tâche d’agent pour automatiser les mises à jour de la documentation, avec création automatique de branches et génération de pull requests (demandes de fusion).

POST /v1/agent/{projectId}/job

Créer une tâche d’agent (v1)

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "branch": "<string>",
  "asDraft": false,
  "model": "sonnet"
}
'

200

"<string>"

Cet endpoint est obsolète. Utilisez plutôt l’endpoint v2 create agent job.

Cet endpoint crée une tâche d’agent à partir des messages fournis et des informations de branche. La tâche s’exécute de manière asynchrone et renvoie une réponse en streaming contenant les détails d’exécution et les résultats.

Si la branche n’existe pas, l’agent en crée une. Si des fichiers sont modifiés avec succès, une pull request (demande de fusion) est automatiquement créée à la fin de la tâche.

​

Limites de débit

L’API de l’agent est soumise aux limites suivantes :

• 100 utilisations par projet Mintlify et par heure

​

Utilisation recommandée

Pour de meilleurs résultats, utilisez le hook useChat d’ai-sdk pour envoyer des requêtes et gérer les réponses.

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

messages · object[] · requis

Une liste de messages à fournir à l’agent. Une invite système par défaut est toujours ajoutée automatiquement au début. Vous n’avez donc généralement besoin d’inclure que des messages utilisateur.

Show child attributes

branch · string

Le nom de la branche Git sur laquelle l’agent doit travailler. S’il est omis, l’agent génère un nom de branche à partir du contenu des messages.

asDraft · boolean · défaut: false

Détermine si la pull request (demande de fusion) est créée en mode brouillon ou non. Si la valeur est true, crée une pull request (demande de fusion) en brouillon. Si la valeur est false (par défaut), crée une pull request (demande de fusion) prête à être examinée.

model · enum<string> · défaut: sonnet

Le modèle d’IA à utiliser pour la tâche d’agent. Utilisez sonnet pour un traitement plus rapide et plus économique. Utilisez opus pour un traitement plus performant, mais plus lent.

Options disponibles: sonnet, opus

Réponse

200 - text/plain

Tâche d’agent créée avec succès (réponse en flux). L’en-tête X-Session-Id est renvoyé dans la réponse

Réponse en flux contenant les détails d’exécution et les résultats de la tâche d’agent.