Saltar al contenido principal
GET
/
agent
/
{projectId}
/
job
/
{id}
Obtener tarea de agente por ID
curl --request GET \
  --url https://api.mintlify.com/v1/agent/{projectId}/job/{id} \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "subdomain": "<string>",
  "branch": "<string>",
  "haulted": true,
  "haultReason": "completed",
  "pullRequestLink": "<string>",
  "messageToUser": "<string>",
  "todos": [
    {
      "content": "<string>",
      "status": "pending",
      "priority": "high",
      "id": "<string>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

​
Uso

Este endpoint obtiene los detalles y el estado de un trabajo de agente específico mediante su identificador único. Úsalo para comprobar el progreso, el estado y los resultados de un trabajo de agente creado previamente.

​
Detalles del trabajo

La respuesta incluye información como:
  • Estado de ejecución del trabajo y estado de finalización
  • Información de la branch y detalles de la solicitud de extracción
  • metadata de la sesión y marcas de tiempo

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

​
id
string
required

El identificador único del trabajo de agente que se debe recuperar.

Response

200 - application/json

Los detalles de la tarea del agente se han recuperado correctamente

​
sessionId
string

El subdomain al que corresponde esta sesión.

​
subdomain
string

El subdominio al que pertenece esta sesión.

​
branch
string | null

Nombre de la branch de Git en la que se realizaron los cambios.

​
haulted
boolean

Indica si se interrumpió la ejecución de la sesión.

​
haultReason
enum<string>

Motivo de la interrupción de la sesión.

Opciones disponibles:
completed,
github_missconfigured,
error
​
pullRequestLink
string

Enlace a la solicitud de extracción creada.

​
messageToUser
string

Mensaje para el usuario acerca del resultado de la sesión.

​
todos
object[]

Lista de tareas pendientes de la sesión.

​
createdAt
string<date-time>

Marca de tiempo de creación de la sesión.