Passer au contenu principal
POST
/
agent
/
job
/
{projectId}
Create agent job
curl --request POST \
  --url https://api.mintlify.com/v1/agent/job/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "branch": "<string>",
  "messages": [
    {
      "role": "system",
      "content": "<string>"
    }
  ]
}'
"<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 façon 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) en mode brouillon est automatiquement créée à la fin de la tâche.

​
Limites de débit

L’API de l’agent présente les 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 traiter les réponses.

Authorizations

​
Authorization
string
header
required

The Authorization header expects a Bearer token. Create an Admin API Key here.

Path Parameters

​
projectId
string
required

The ID of your project. Can be retrieved from your dashboard.

Body

application/json
​
branch
string
required

The name of the Git branch that the agent should work on, will be automatically created if it doesn't exist

​
messages
object[]
required

A list of previous messages to provide to the agent.

Response

200 - text/plain

Agent job created successfully (streaming response). X-Session-Id Header is sent back in the response

Streaming response containing the agent job execution details and results.

⌘I