Antes de empezar
- Un token de API con modo
read_write, creado en Settings → API tokens (autenticación). - El ID del agente, visible en la página del agente en el panel.
Crear un run
Envía la instrucción eninput.message. Si el run reacciona a un evento, pon el payload del evento en input.data — el agente lo recibe como datos, nunca como instrucciones.
string
requerido
La instrucción para el agente. Hasta 128 KiB.
object
JSON libre con datos del evento, hasta 128 KiB. Llega al agente marcado como
dato no confiable — úsalo para payloads que vienen del mundo externo.
object
Hasta 16 claves de texto (valores de hasta 512 caracteres). Se devuelve en el
run y en los webhooks — úsalo para correlacionar con registros de tu sistema.
string
Continúa una sesión de API existente de este agente en lugar de iniciar una
conversación nueva. Los runs de la misma sesión se procesan en orden.
string
URL HTTPS notificada cuando el run termina. Mira
Webhooks de finalización.
string
Título opcional para la nueva sesión, visible en el panel.
202 Accepted con el recurso del run:
Envía siempre un
Idempotency-Key. Si tu solicitud se reintenta, recibes el
run original en lugar de un duplicado. Detalles en la
visión general de la API.Seguir el run
Consulta la URL deurls.self hasta que el estado sea terminal:
Las respuestas no terminales incluyen un header
retry-after con el intervalo sugerido entre consultas. Cuando el run termina:
Un run en
waiting_approval se reanuda cuando alguien aprueba la acción
pendiente en el panel. Si registraste un callbackUrl, también recibes un
evento run.waiting_approval en ese momento — útil para avisar a quien
aprueba.callbackUrl y recibe un webhook firmado al finalizar — mira Webhooks de finalización.
Listar runs
{ "runs": [...], "nextCursor": "..." }, del más reciente al más antiguo. Pasa cursor para la siguiente página y status para filtrar (por ejemplo, status=failed).
Cancelar un run
queued pueden cancelarse. Un run ya en ejecución devuelve 409 not_cancellable; cancelar un run ya terminado es inofensivo y devuelve el recurso sin cambios.
Continuar una conversación
Cada run sinsessionId inicia una sesión nueva. Para mantener contexto entre runs — una conversación continua con el mismo agente — reutiliza el sessionId devuelto por el primer run: