Passer au contenu principal
POST
/
agent
/
{projectId}
/
job
Créer une tâche d’agent
curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ],
  "branch": "<string>",
  "asDraft": false,
  "model": "sonnet"
}
'
"<string>"
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

Votre ID de projet. Vous pouvez le copier à partir de 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 automatiquement ajoutée en premier, vous n’avez donc généralement besoin d’inclure que les messages utilisateur.

​
branch
string

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

​
asDraft
boolean
défaut:false

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

​
model
enum<string>
défaut:sonnet

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

Options disponibles:
sonnet,
opus

Réponse

200 - text/plain

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

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