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 ici le contrat OpenAPI actuel 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 en tant que 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.

La réponse inclut capabilities : les capacités de la clé. Une clé ne peut effectuer que ce que son Role et son créateur peuvent tous deux faire.

Lors d’une opération concernant un Assistant, le Role du créateur sur cet Assistant s’applique. Si seul ce Role d’Assistant refuse l’opération, l’API renvoie 404, comme pour un Assistant qui n’existe pas.

Erreurs de réponse

Les erreurs utilisent une seule enveloppe JSON :

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

Les codes de statut 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ûres

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 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.
• Memories : inspectez les paramètres et effectuez un effacement de la mémoire dans un périmètre défini.
• 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’ordre et la cible de ticketing.
• Teammates : gérez les Teammates IA et consultez vos propres conversations avec les Teammates.
• Projects : gérez les Projects, leurs milestones et les documents de Project que les Teammates consultent.
• Tasks : lister, lire, créer, modifier, archiver et supprimer les Tasks, les commenter et gérer les Labels de tâches. La liste filtre par Project, assignee, status, Label, due dates, text et Improvement, et utilise un curseur pour chaque page. Une clé ne lit que les Projects que son membre peut lire. Un commentaire indique ce membre comme étant l’auteur.
• Reviews : listez, lisez et prenez des décisions concernant les demandes de revue humaine.
• Channels : consultez et configurez les canaux des coéquipiers 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.
• Organization : gérez les paramètres, les Members, les Invites et les clés API. Limitez un Member aux Assistants sélectionnés.
• Integrations : gérez les intégrations d’API d’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, l’addition des dimensions la comptabilise 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.
• Journal d’audit : consultez qui a modifié quoi, depuis quelle interface, avec la valeur avant et après pour les modifications concernant le rôle, l’invitation, la clé, l’accès et les paramètres. Lecture seule. Filtrez par action, acteur et date. Pour consulter des entrées plus anciennes, envoyez les createdAt et id de la dernière entrée dont vous disposez en tant que before et beforeId.

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