Saltar al contenido principal
POST
/
agent
/
{projectId}
/
job
Crear tarea de agente
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,
  "model": "sonnet"
}
'
"<string>"
Este endpoint crea un trabajo del agente a partir de los mensajes proporcionados y la información de la branch. El trabajo se ejecuta de forma asíncrona y devuelve una respuesta en streaming con los detalles de la ejecución y los resultados. Si no existe una branch, el agente crea una. Si los archivos se editan correctamente, al finalizar el trabajo se crea automáticamente una solicitud de extracción.

​
Límites de tasa

La API del agente tiene los siguientes límites:
  • 100 usos por proyecto de Mintlify por hora

​
Uso recomendado

Para obtener mejores resultados, utiliza el hook useChat de ai-sdk para enviar solicitudes y gestionar las respuestas.

Authorizations

​
Authorization
string
header
required

El encabezado Authorization requiere un token Bearer. Crea una Admin API Key aquí.

Path Parameters

​
projectId
string
required

El ID de tu proyecto. Puedes copiarlo desde la página de API keys en tu panel de control.

Body

application/json
​
branch
string
required

El nombre de la branch de Git en la que debe trabajar el agente; se creará automáticamente si no existe

​
messages
object[]
required

Una lista de mensajes para proporcionar al agente. Siempre se antepone automáticamente un mensaje del sistema predeterminado, por lo que normalmente solo es necesario incluir mensajes de usuario.

​
asDraft
boolean
default:true

Controla si la solicitud de extracción se crea en modo borrador o en modo no borrador. Cuando es true, crea una solicitud de extracción en borrador. Cuando es false, crea una solicitud de extracción normal (no borrador) lista para revisión.

​
model
enum<string>
default:sonnet

Modelo de IA que se utilizará para la tarea del agente. Usa sonnet para un procesamiento más rápido y económico. Usa opus para un procesamiento más potente, pero más lento.

Opciones disponibles:
sonnet,
opus

Response

200 - text/plain

Trabajo de agente creado correctamente (respuesta en streaming). El encabezado X-Session-Id se devuelve en la respuesta

Respuesta en streaming que contiene los detalles y resultados de la ejecución de la tarea del agente.