Saltar al contenido principal

kobana inbox agents

Comandos de kobana inbox agents. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
agents listGET /v1/agentsListar Agents
agents createPOST /v1/agentsCrear Agent
agents updatePUT /v1/agentsCrear o actualizar agente
agents getGET /v1/agents/{id}Obtener Agent
agents deleteDELETE /v1/agents/{id}Eliminar Agent
agents versionsGET /v1/agents/{id}/versionsListar versiones del prompt del agente

agents list​

Listar Agents

kobana inbox agents list [OPCIONES]

GET /v1/agents

Paginación keyset. Los filtros son query params tipados (campo=valor, campo[op]=valor); los filtros desconocidos, los campos no ordenables y los valores malformados se rechazan con 400 VALIDATION_ERROR.

Parámetros de consulta

NombreTipoObligatorioDescripción
limitintegerno
cursorstringnoCursor opaco devuelto en meta.next_cursor de la página anterior.
sort_bystringnoCampo por el que ordenar. Permitidos: created_at, updated_at, label, version. Sin él, el orden es created_at descendente. Valores: created_at, updated_at, label, version.
sort_orderstringnoasc (por defecto) o desc. Requiere sort_by. Valores: asc, desc.
llm_modelstringnoIgualdad. También llm_model[in]=a,b.
external_idstringnoIgualdad. También external_id[in]=a,b.
created_atstringnoIgualdad. También created_at[in]=a,b y created_at[gt|gte|lt|lte].
created_at[gte]stringno
created_at[lte]stringno
updated_atstringnoIgualdad. También updated_at[in]=a,b y updated_at[gt|gte|lt|lte].
updated_at[gte]stringno
updated_at[lte]stringno

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Página de resultados.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.

agents create​

Crear Agent

kobana inbox agents create [OPCIONES]

POST /v1/agents

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
labelstringsí
llm_modelstringsí
system_messagestringsí
external_idstringnoOpcional. Por defecto usa el id interno generado.
skills_repostring (uri)no
workflow_allowed_hostsarray<string>noHosts (exactos, p. ej. api.example.com) a los que un workflow devuelto por este agente puede enviar ${{secrets.*}}, ${{email.attachments.*}} o la salida de un paso derivada de ellos. Vacío (el valor por defecto) bloquea todos los destinos para esos valores; los pasos sin ellos no se ven afectados.
custom_metadataobjectnoMetadatos del usuario, formato libre. Envía null para limpiarlos. Máx. 64 KB serializados, 16 niveles de profundidad.

Otros campos y objetos anidados: kobana schema inbox.agents.create.

Respuestas

HTTPDescripción
201Éxito.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.
409Se violó una restricción de unicidad (por ejemplo, external_id o el email del inbox ya en uso).
422Validación del cuerpo que requiere contexto del lado del servidor (por ejemplo, dominio del inbox no coincide).

agents update​

Crear o actualizar agente

kobana inbox agents update [OPCIONES]

PUT /v1/agents

Upsert. Recibe el mismo cuerpo que POST más las claves de búsqueda id y external_id, comparadas en ese orden. Una coincidencia se actualiza in situ y devuelve 200 — los campos ausentes del cuerpo conservan el valor almacenado. Sin clave, o sin coincidencia, crea el agente exactamente como lo haría POST y devuelve 201.

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
labelstringsí
llm_modelstringsí
system_messagestringsí
external_idstringnoCoincide por el id del sistema de origen. También se guarda en el registro cuando se crea.
skills_repostring (uri)no
workflow_allowed_hostsarray<string>noHosts (exactos, p. ej. api.example.com) a los que un workflow devuelto por este agente puede enviar ${{secrets.*}}, ${{email.attachments.*}} o la salida de un paso derivada de ellos. Vacío (el valor por defecto) bloquea todos los destinos para esos valores; los pasos sin ellos no se ven afectados.
custom_metadataobjectnoMetadatos del usuario, formato libre. Envía null para limpiarlos. Máx. 64 KB serializados, 16 niveles de profundidad.
idstring (uuid)noCoincide por el id interno. Se comprueba antes que external_id.

Otros campos y objetos anidados: kobana schema inbox.agents.update.

Respuestas

HTTPDescripción
200Éxito.
201Éxito.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.
409Se violó una restricción de unicidad (por ejemplo, external_id o el email del inbox ya en uso).
422Validación del cuerpo que requiere contexto del lado del servidor (por ejemplo, dominio del inbox no coincide).

agents get​

Obtener Agent

kobana inbox agents get [ID] [OPCIONES]

GET /v1/agents/{id}

Acepta el UUID interno o el external_id del recurso.

Argumentos de la ruta: id

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Éxito.
404Recurso no encontrado o excluido por soft-delete.

agents delete​

Eliminar Agent

kobana inbox agents delete [ID] [OPCIONES]

DELETE /v1/agents/{id}

Acepta el UUID interno o el external_id del recurso.

Argumentos de la ruta: id

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Eliminado (soft delete).
404Recurso no encontrado o excluido por soft-delete.

agents versions​

Listar versiones del prompt del agente

kobana inbox agents versions [ID] [OPCIONES]

GET /v1/agents/{id}/versions

Paginación keyset. Los filtros son query params tipados (campo=valor, campo[op]=valor); los filtros desconocidos, los campos no ordenables y los valores malformados se rechazan con 400 VALIDATION_ERROR.

Argumentos de la ruta: id

Parámetros de consulta

NombreTipoObligatorioDescripción
limitintegerno
cursorstringnoCursor opaco devuelto en meta.next_cursor de la página anterior.
sort_bystringnoCampo por el que ordenar. Permitidos: created_at, version. Sin él, el orden es version descendente. Valores: created_at, version.
sort_orderstringnoasc (por defecto) o desc. Requiere sort_by. Valores: asc, desc.
versionintegernoIgualdad. También version[in]=a,b y version[gt|gte|lt|lte].
version[gte]integerno
version[lte]integerno
created_atstringnoIgualdad. También created_at[in]=a,b y created_at[gt|gte|lt|lte].
created_at[gte]stringno
created_at[lte]stringno

Encabezados

NombreTipoObligatorioDescripción
x-origin-shared-secretstringnoSecreto compartido entre CloudFront y el origin. Obligatorio en producción; se ignora en desarrollo a menos que se configure CF_ORIGIN_SHARED_SECRET.

Respuestas

HTTPDescripción
200Página de resultados.
400El cuerpo no superó la validación de Zod. error.details contiene formErrors/fieldErrors.
404Recurso no encontrado o excluido por soft-delete.