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.

POST /v1/agent/{projectId}/job

Crear trabajo del agente (v1)

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "content": "<string>"
    }
  ],
  "branch": "<string>",
  "asDraft": false,
  "model": "sonnet"
}
'

200

"<string>"

Este endpoint está en desuso. Usa el endpoint crear trabajo del agente v2 en su lugar.

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.

Autorizaciones

Authorization · string · header · requerido

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.

Parámetros de ruta

projectId · string · requerido

El ID de tu proyecto. Se puede copiar desde la página de API keys en tu dashboard.

Cuerpo

application/json

messages · object[] · requerido

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

branch · string

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.

asDraft · boolean · predeterminado: false

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.

model · enum<string> · predeterminado: sonnet

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.

Opciones disponibles: sonnet, opus

Respuesta

200 - text/plain

La tarea del agente se creó correctamente (respuesta en streaming). El encabezado X-Session-Id se devuelve en la respuesta

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