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 '
{
  "branch": "<string>",
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ],
  "asDraft": true
}
'
"<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.

Authorizations

​
Authorization
string
header
required

L’en-tête Authorization requiert un jeton Bearer. Créez une clé API d’administration ici.

Path Parameters

​
projectId
string
required

Votre ID de projet. Vous pouvez le copier à partir de la page API keys de votre Dashboard.

Body

application/json
​
branch
string
required

Le nom de la branche Git sur laquelle l’agent doit travailler (la branche sera automatiquement créée si elle n’existe pas)

​
messages
object[]
required

Une liste de messages précédents à fournir à l’agent.

​
asDraft
boolean
default:true

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

Response

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.