Get started
Create content
Document APIs
Deploy
Crear trabajo del agente (v1)
En desuso. Crea un trabajo del agente para automatizar las actualizaciones de la documentación, con creación automática de branch y generación de solicitud de extracción.
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>"Documentation Index
Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Límites de tasa
- 100 usos por proyecto de Mintlify por hora
Uso recomendado
Authorizations
El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador (con el prefijo mint_). Esta es una clave secreta del lado del servidor. Genera una clave en la página de claves de API de tu dashboard.
Path Parameters
Body
Una lista de mensajes para proporcionar al agente. Siempre se antepone automáticamente un prompt del sistema predeterminado, por lo que normalmente solo necesitas incluir mensajes del usuario.
Show child attributes
Show child attributes
El nombre de la branch de Git en la que debe trabajar el agente. Si se omite, el agente genera un nombre de branch a partir del contenido del mensaje.
Controla si la solicitud de extracción se crea en modo borrador o en modo normal. Cuando es true, crea una solicitud de extracción en borrador. Cuando es false (predeterminado), crea una solicitud de extracción regular lista para revisión.
El modelo de IA que se usará para el trabajo del agente. Usa sonnet para un procesamiento más rápido y rentable. Usa opus para un procesamiento más capaz, pero más lento.
sonnet, opus Response
Tarea de agente creada correctamente. Devuelve una respuesta en streaming con Server-Sent Events.
Flujo Server-Sent Events que contiene los detalles de ejecución y resultados de la tarea de agente.
Was this page helpful?
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>"Suggestions