Saltar al contenido principal
POST
/
v2
/
agent
/
{projectId}
/
job
Crear trabajo del agente
curl --request POST \
  --url https://api.mintlify.com/v2/agent/{projectId}/job \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>"
}
'
{
  "id": "<string>",
  "status": "active",
  "source": {
    "repository": "<string>",
    "ref": "<string>"
  },
  "model": "<string>",
  "prLink": "https://github.com/org/repo/pull/123",
  "createdAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}
Este endpoint crea una tarea de agente en segundo plano. La tarea se ejecuta de forma asíncrona; usa el endpoint get agent job para consultar las actualizaciones de estado. Si el agente edita los archivos correctamente, se crea automáticamente una solicitud de extracción y se rellena el campo prLink en la respuesta de la tarea.

​
Límites de uso

  • 100 usos por hora por proyecto de Mintlify

​
Uso

curl -X POST https://api.mintlify.com/v2/agent/{projectId}/job \
  -H "Authorization: Bearer mint_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "Add a quickstart guide for the Python SDK"}'

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. Puedes copiarlo desde la página de API keys en tu dashboard.

Cuerpo

application/json
​
prompt
string
requerido

La instrucción que debe ejecutar el agente.

Minimum string length: 1

Respuesta

Trabajo del agente creado correctamente

​
id
string

Identificador único del trabajo del agente.

​
status
enum<string>

Estado actual del trabajo. active — el agente está procesando actualmente el prompt. completed — el agente finalizó correctamente y es posible que se haya creado una PR (consulta prLink). failed — el agente encontró un error irrecuperable. Sigue consultando hasta que el estado sea completed o failed.

Opciones disponibles:
active,
completed,
failed
​
source
object

Información del repositorio de origen.

​
model
string

El modelo de IA utilizado para esta tarea.

​
prLink
string<uri> | null

URL de la solicitud de extracción de GitHub creada por el agente. null mientras la tarea siga active o si no se ha cambiado ningún archivo. Se completa cuando el agente crea correctamente una PR.

Ejemplo:

"https://github.com/org/repo/pull/123"

​
createdAt
string<date-time>

Marca de tiempo de creación de la tarea.

​
archivedAt
string<date-time> | null

Marca de tiempo de archivado de la tarea.