API v1

Llama a la API de administración actual de Ciele con una clave API de organización.

La API de Ciele utiliza JSON sobre HTTP. Todas las rutas de la versión 1 comienzan por /api/v1.

Abre la referencia interactiva de la API para explorar todas las operaciones públicas por dominio. Descarga allí el contrato OpenAPI actual en formato JSON o YAML.

Descubre el despliegue

Utiliza estos puntos de conexión públicos antes de generar un cliente:

GET /api/v1/meta
GET /api/v1/openapi.json

meta muestra la versión de la API y los dominios disponibles. openapi.json devuelve el contrato legible por máquina para el despliegue.

Autenticar una solicitud

Envía la clave de API como token bearer:

curl https://ciele.app/api/v1/whoami \
  --header "Authorization: Bearer $CIELE_API_KEY"

Para el autoalojamiento, sustituye https://ciele.app por el origen público de Ciele.

Errores de respuesta

Los errores utilizan una única envolvente JSON:

{
  "error": {
    "code": "forbidden",
    "message": "This API key cannot perform this operation."
  }
}

Los códigos de estado más habituales son:

Status	Significado
`400`	El cuerpo de la solicitud está mal formado o falta un archivo obligatorio.
`401`	La clave no existe, no es válida o ha sido revocada.
`403`	El Role de la clave no permite la operación.
`404`	El recurso no existe en la Organization.
`409`	La solicitud entra en conflicto con el estado actual.
`422`	Los datos analizados no superan la validación.

Paginación

Utiliza los parámetros de paginación que se muestran en cada operación. Las listas basadas en cursores devuelven nextCursor. Pásalo como cursor en la siguiente solicitud.

Reintentos seguros

Las rutas de mutación pueden aceptar un encabezado Idempotency-Key. Reutiliza el mismo valor solo cuando vuelvas a intentar la misma operación lógica.

Dominios comunes

Estos son ejemplos. La API reference enumera el conjunto completo y actual de operaciones.

Asistentes: listar, leer, crear, actualizar, duplicar y eliminar.
Flujos: listar, leer, crear, actualizar, reordenar y eliminar.
Knowledge: gestiona Collections, Sources, FAQs y los enlaces del asistente en cada Source.
Publicación: consultar el estado, publicar, anular la publicación y restaurar una publicación.
Bandeja de entrada: revisa, exporta, ancla, anota, valora y elimina Conversaciones.
Mejoras: enumera, lee y actualiza elementos.
Entidades y recuerdos: gestiona los datos tipados de la organización y el borrado de recuerdos con ámbito definido.
SSO: gestiona las afirmaciones de identidad, la configuración de conexión, la validación y la desconexión.
Help Desks: gestiona los desks, los canales de escalado, la ordenación y ServiceNow.
Teammates: gestiona a los Teammates de IA y lee tus propias conversaciones con Teammates.
Canales: lee y da forma a los canales de compañeros de equipo en los que participas, así como a sus listas de miembros. No hay ningún endpoint para enviar un mensaje: un mensaje inicia una cadena de respuestas de compañeros de equipo, y esa cadena se ejecuta en la consola.
Configuration: gestiona Skills, Assistant Goals y Alerts operativas.
Organization: gestiona la configuración, los Members, las Invites y las claves API.
Integrations: gestiona las integraciones de la API del asistente y las conexiones con los proveedores de modelos.
Uso: consulta los contadores del plan y quién ha gastado los créditos de una ventana. Solo lectura. El desglose del gasto mantiene sus dimensiones separadas. Una respuesta menciona tanto al compañero de equipo que ejecutó la acción como al compañero que la solicitó, por lo que sumar las dimensiones la cuenta dos veces. La compra de créditos no tiene un endpoint: una compra corresponde a una pantalla en la que una persona confirma un importe.

Utiliza el documento OpenAPI para los campos de las solicitudes, la autenticación y los códigos de estado de las respuestas documentados.