API v1

L'API Ciele utilise JSON sur HTTP. Toutes les routes de la version 1 commencent par /api/v1.

Ouvrez la référence API interactive pour parcourir toutes les opérations publiques par domaine. Téléchargez le contrat OpenAPI actuel à cet endroit au format JSON ou YAML.

Découvrir le déploiement

Utilisez ces points de terminaison publics avant de générer un client :

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

meta répertorie la version de l'API et les domaines disponibles. openapi.json renvoie le contrat lisible par machine pour le déploiement.

Authentifier une requête

Envoyez la clé API sous la forme d'un bearer token :

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

Pour l'auto-hébergement, remplacez https://ciele.app par l'origine publique de Ciele.

Erreurs de réponse

Les erreurs utilisent une seule enveloppe JSON :

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

Les codes d'état courants sont :

Pagination

Utilisez les paramètres de pagination indiqués pour chaque opération. Les listes basées sur un curseur renvoient nextCursor. Transmettez-le en tant que cursor lors de la requête suivante.

Nouvelles tentatives sécurisées

Les routes de mutation peuvent accepter un en-tête Idempotency-Key. Réutilisez la même valeur uniquement lorsque vous tentez à nouveau la même opération logique.

Domaines courants

Ce sont des exemples. La référence de l'API répertorie l'ensemble complet et actuel des opérations.

• Assistants : list, read, create, update, duplicate et delete.
• Flows : list, read, create, update, reorder et delete.
• Knowledge : gérez les Collections, les Sources, les FAQ et les liens de l'Assistant sur chaque Source.
• Publication : consulter le statut, publier, annuler la publication et restaurer une publication.
• Inbox : consulter, exporter, épingler, annoter, évaluer et supprimer des Conversations.
• Améliorations : lister, lire et mettre à jour les éléments.
• Entities and Memories : gérez les données typées de l'organisation et l'effacement des mémoires selon leur champ d'application.
• SSO : gérez les revendications d'identité, les paramètres de connexion, la validation et la déconnexion.
• Help Desks : gérez les desks, les canaux d'escalade, l'ordonnancement et ServiceNow.
• Teammates : gérez les Teammates IA et lisez vos propres conversations de Teammate.
• Channels : consultez et configurez les canaux des Teammates auxquels vous appartenez, ainsi que leurs rosters. Il n'existe pas de point de terminaison pour envoyer un message : un message déclenche une chaîne de réponses des coéquipiers, qui s'exécute dans la console.
• Configuration : gérez les Skills, les Assistant Goals et les Alertes opérationnelles.
• Organisation : gérez les paramètres, les Members, les Invites et les clés API.
• Integrations : gérez les intégrations de l'API de l'assistant et les connexions aux fournisseurs de modèles.
• Usage : consultez les compteurs du plan et identifiez qui a dépensé les crédits d'une fenêtre. Lecture seule. La ventilation des dépenses conserve ses dimensions distinctes. Une même réponse désigne à la fois le coéquipier qui a exécuté l'opération et le collègue qui l'a demandée ; par conséquent, additionner les dimensions revient à la compter deux fois. L'achat de crédits n'a pas de point de terminaison : un achat s'effectue sur un écran où une personne confirme un montant.

Utilisez le document OpenAPI pour les champs de requête, l'authentification et les codes de statut de réponse documentés.