API Compound
Développez avec Compound
L'API REST de Compound donne à vos logiciels les mêmes agents que ceux de vos analystes. Créez un agent pour chacun de vos utilisateurs, envoyez-lui des fichiers et des questions, puis suivez son travail en direct.
Ce que l'API permet de faire
Tout ce que fait la CLI de Compound est disponible via HTTPS, avec les mêmes autorisations et les mêmes résultats.
Agents
Créez autant d'agents que nécessaire, associez à chacun votre propre identifiant externe, puis listez-les, modifiez-les ou supprimez-les.
Messages et événements en direct
Envoyez un message à un agent et recevez en continu ses réponses, les changements de ses tâches, ses propositions et chaque opération qu'il exécute sous forme de server-sent events.
Tâches et propositions
Suivez les tâches sur lesquelles travaille un agent et approuvez ou rejetez les modifications qu'il propose.
Fichiers
Importez des documents sources, téléchargez les fichiers Excel, Word, PowerPoint et PDF produits par un agent, et consultez leur historique de versions.
Partage et projets
Partagez le Drive d'un agent avec les membres de votre équipe et regroupez les travaux connexes en projets.
Planifications
Exécutez un agent selon un calendrier, par exemple une mise à jour hebdomadaire de portefeuille ou une synthèse matinale de l'actualité.
Boîte de réception et commentaires
Consultez la boîte de réception d'un agent et les fils de commentaires laissés sur ses fichiers.
Listes de sociétés suivies
Choisissez les sociétés cotées qu'un agent suit afin qu'il prenne en compte leurs dépôts réglementaires et leur actualité.
Consommation
Consultez les crédits de votre forfait et ce que vous avez dépensé pour chaque agent.
Votre première requête
Trois appels couvrent la boucle essentielle : créer un agent pour l'un de vos utilisateurs, lui envoyer un message et suivre sa progression en direct.
1. Exportez la clé d'API que nous avons émise pour votre organisation, à la place de l'espace réservé.
export COMPOUND_API_KEY="<your-api-key>"2. Créez un agent et associez-lui l'identifiant que votre système utilise pour cet utilisateur.
AGENT_ID=$(curl -X POST https://ws.getcompound.ai/v1/agents \ -H "Authorization: Bearer $COMPOUND_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"Research agent","external_id":"user-4821"}' | jq -r .id)3. Envoyez un message à l'agent.
curl -X POST https://ws.getcompound.ai/v1/agents/$AGENT_ID/messages \ -H "Authorization: Bearer $COMPOUND_API_KEY" \ -H "Content-Type: application/json" \ -d '{"text":"Summarize the latest 10-K and build a three-statement model."}'4. Suivez les événements de l'agent en continu pendant qu'il travaille.
curl -N https://ws.getcompound.ai/v1/agents/$AGENT_ID/events \ -H "Authorization: Bearer $COMPOUND_API_KEY"
Fonctionnement de l'accès
L'accès à l'API n'est pas en libre-service. Nous configurons chaque organisation avec notre équipe afin que le compte, la facturation et les limites correspondent à votre usage.
01
Demandez une démo
Indiquez-nous ce que vous souhaitez développer et combien de personnes ou de systèmes appelleront l'API.
02
Nous activons votre organisation
Notre équipe crée un compte API pour votre équipe ou votre entreprise et convient avec vous des limites et de la facturation.
03
Vous recevez vos clés API
Nous émettons des clés pour votre organisation. Transmettez-les dans l'en-tête Authorization sous forme de jeton Bearer.
Les clés API appartiennent à votre organisation, et non à une personne. Une seule clé peut créer un agent pour chaque utilisateur de votre entreprise, et elle continue de fonctionner lorsque des collaborateurs arrivent ou partent.
Sécurité
Clés stockées sous forme hachée
Nous ne conservons qu'un hachage de chaque clé. La clé complète n'est affichée qu'une seule fois, à son émission.
Révocable à tout moment
Demandez-nous de révoquer une clé et toute requête qui l'utilise est immédiatement rejetée. Faites émettre une nouvelle clé avant de procéder à la rotation.
Débit limité
Chaque organisation dispose de limites de requêtes, de sorte qu'un script défaillant ne ralentit pas le reste de votre activité.
Vos données restent les vôtres
Une clé API n'accède qu'aux agents et aux fichiers de sa propre organisation. Les mêmes contrôles de sécurité que dans l'application Compound s'appliquent.
Spécification OpenAPI
La spécification décrit tous les points de terminaison et fonctionne avec n'importe quel outil OpenAPI ou générateur de clients.
Questions fréquentes
Non. Demandez une démo : notre équipe active un compte API pour votre organisation, puis émet ses clés.
Autant que votre organisation en a besoin. Une configuration courante consiste à créer un agent par collaborateur de votre entreprise, tous avec la même clé d'organisation.
Transmettez un identifiant externe lors de la création d'un agent et filtrez dessus lorsque vous listez les agents. Compound conserve cette valeur sans jamais l'interpréter.
La CLI repose sur la même API : tout ce que vous faites depuis la CLI, vous pouvez le faire via HTTPS. Les utilisateurs peuvent continuer à se connecter à la CLI avec leur propre compte Compound.
Ouvrez le flux d'événements d'un agent. Il envoie d'abord un instantané de l'état de l'agent, puis un server-sent event pour chaque nouveau message, changement de tâche, proposition et opération. Reconnectez-vous avec le dernier curseur lu pour reprendre là où vous vous êtes arrêté.
L'utilisation de l'API consomme les crédits Compound de votre organisation. Nous convenons avec vous des tarifs et des limites lors de l'activation de votre compte.
Parlons de l'API
Indiquez-nous ce que vous souhaitez développer. Nous configurerons votre organisation et vous remettrons vos clés.