Saltar al contenido principal

Workspaces

Un workspace es el tenant al que pertenece un inbox. Seis tools; las de escritura están restringidas a tokens de sistema, porque un workspace lo aprovisiona el sistema de origen, no un usuario final.

Ver el modelo Workspace para la forma del objeto devuelto.


workspaces_list​

Lectura · scope inbox/workspaces · permiso workspaces.list · GET /workspaces

Lista los workspaces de la organización del token. Paginado por cursor; devuelve { data, meta: { next_cursor } }.

ParámetroTipoDescripción
cursorstringCursor opaco de una página anterior.
limitintegerTamaño de página, por defecto 25, máximo 100.
sortstringClaves de ordenación, prefijo - para descendente.
sourcestringFiltra por sistema de origen, p.ej. kobana_app.
slugstringFiltra por slug.
external_idstringFiltra por el id en el sistema de origen.
created_at_gtestringcreated_at desde este timestamp ISO 8601.
created_at_ltestringcreated_at hasta este timestamp ISO 8601.

workspaces_get​

Lectura · scope inbox/workspaces · permiso workspaces.show · GET /workspaces/{id}

Obtiene un workspace por id interno o external_id.

ParámetroTipoDescripción
id obligatoriostringId interno o external_id.

workspaces_create​

Escritura · scope inbox/workspaces + write · permiso workspaces.create · POST /workspaces

Crea un workspace. Requiere un token src=system.

ParámetroTipoDescripción
label obligatoriostringNombre visible, 1–120 caracteres.
external_idstringId del registro en el sistema de origen.
sourcestringSistema de origen, p.ej. kobana_app.
slugstringMinúsculas, con guiones. Pasa a ser un segmento de la dirección de cada inbox.
monthly_cost_limitnumber | nullTecho mensual de coste de LLM.
monthly_emails_limitinteger | nullTecho mensual de correos procesados.
custom_metadataobjectJSON libre, de quien llama.
idempotency_keystringProtección contra repeticiones, 8–255 caracteres.

workspaces_upsert​

Escritura · scope inbox/workspaces + write · permiso workspaces.create · PUT /workspaces

Crea o actualiza un workspace, emparejado por id y luego external_id. Responde 200 al actualizar y 201 al crear. Requiere un token src=system.

ParámetroTipoDescripción
idstring (uuid)Empareja primero por id interno.
labelstringNombre visible, 1–120 caracteres.
external_idstringClave de emparejamiento en el sistema de origen.
sourcestringSistema de origen.
slugstringMinúsculas, con guiones.
monthly_cost_limitnumber | nullTecho mensual de coste.
monthly_emails_limitinteger | nullTecho mensual de correos.
custom_metadataobjectJSON libre.
idempotency_keystringProtección contra repeticiones.

workspaces_update​

Escritura · scope inbox/workspaces + write · permiso workspaces.update · PATCH /workspaces/{id}

Actualiza un workspace en su sitio. Cambiar los límites requiere un token src=system.

ParámetroTipoDescripción
id obligatoriostringId interno o external_id.
labelstringNombre visible, 1–120 caracteres.
external_idstringId en el sistema de origen.
sourcestringSistema de origen.
slugstringMinúsculas, con guiones.
monthly_cost_limitnumber | nullTecho mensual de coste.
monthly_emails_limitinteger | nullTecho mensual de correos.
custom_metadataobjectJSON libre.

workspaces_delete​

Destructiva · scope inbox/workspaces + write · permiso workspaces.delete · DELETE /workspaces/{id}

Elimina (soft-delete) un workspace. Requiere un token src=system.

ParámetroTipoDescripción
id obligatoriostringId interno o external_id.