Compound API
Entwickeln Sie mit Compound
Die Compound REST API gibt Ihrer Software dieselben Agenten, die Ihre Analysten nutzen. Erstellen Sie für jeden Ihrer Nutzer einen Agenten, senden Sie ihm Dateien und Fragen und verfolgen Sie seine Arbeit live mit.
Was die API leisten kann
Alles, was die Compound CLI kann, steht auch über HTTPS zur Verfügung, mit denselben Berechtigungen und denselben Ergebnissen.
Agenten
Erstellen Sie beliebig viele Agenten, versehen Sie jeden mit Ihrer eigenen externen ID und listen, ändern oder löschen Sie sie.
Nachrichten und Live-Ereignisse
Senden Sie einem Agenten eine Nachricht und erhalten Sie seine Antworten, Aufgabenänderungen, Vorschläge und jeden ausgeführten Arbeitsschritt als Server-Sent Events im Stream.
Aufgaben und Vorschläge
Verfolgen Sie die Aufgaben, an denen ein Agent arbeitet, und genehmigen oder lehnen Sie seine vorgeschlagenen Änderungen ab.
Dateien
Laden Sie Quelldokumente hoch, laden Sie die von einem Agenten erzeugten Excel-, Word-, PowerPoint- und PDF-Dateien herunter und rufen Sie deren Versionsverlauf ab.
Freigabe und Projekte
Geben Sie das Drive eines Agenten für Personen in Ihrem Team frei und fassen Sie zusammengehörige Arbeiten in Projekten zusammen.
Zeitpläne
Führen Sie einen Agenten nach Zeitplan aus, etwa für ein wöchentliches Portfolio-Update oder eine morgendliche Nachrichtenzusammenfassung.
Posteingang und Kommentare
Lesen Sie den Posteingang eines Agenten und die Kommentarthreads, die Personen an seinen Dateien hinterlassen.
Beobachtungslisten für Unternehmen
Legen Sie fest, welchen börsennotierten Unternehmen ein Agent folgt, damit er deren Veröffentlichungen und Nachrichten berücksichtigt.
Nutzung
Rufen Sie die Credits Ihres Plans und Ihren Verbrauch pro Agent ab.
Ihre erste Anfrage
Drei Aufrufe decken den Kernablauf ab: einen Agenten für einen Ihrer Nutzer erstellen, ihm eine Nachricht senden und seinen Fortschritt live verfolgen.
1. Exportieren Sie den API-Schlüssel, den wir für Ihre Organisation ausgestellt haben, anstelle des Platzhalters.
export COMPOUND_API_KEY="<your-api-key>"2. Erstellen Sie einen Agenten und versehen Sie ihn mit der ID, die Ihr System für diesen Nutzer verwendet.
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. Senden Sie dem Agenten eine Nachricht.
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. Verfolgen Sie die Ereignisse des Agenten im Stream, während er arbeitet.
curl -N https://ws.getcompound.ai/v1/agents/$AGENT_ID/events \ -H "Authorization: Bearer $COMPOUND_API_KEY"
So funktioniert der Zugang
Der API-Zugang ist nicht selbst buchbar. Wir richten jede Organisation gemeinsam mit unserem Team ein, damit Konto, Abrechnung und Limits zu Ihrer Nutzung passen.
01
Demo vereinbaren
Schildern Sie uns, was Sie entwickeln möchten und wie viele Personen oder Systeme die API aufrufen werden.
02
Wir aktivieren Ihre Organisation
Unser Team legt ein API-Konto für Ihr Team oder Unternehmen an und vereinbart mit Ihnen Limits und Abrechnung.
03
Sie erhalten Ihre API-Schlüssel
Wir stellen Schlüssel für Ihre Organisation aus. Senden Sie sie im Authorization-Header als Bearer-Token.
API-Schlüssel gehören Ihrer Organisation, nicht einer einzelnen Person. Ein Schlüssel kann für jeden Nutzer in Ihrem Unternehmen einen Agenten erstellen und funktioniert weiter, wenn Personen hinzukommen oder ausscheiden.
Sicherheit
Schlüssel nur als Hash gespeichert
Wir speichern nur einen Hash jedes Schlüssels. Der vollständige Schlüssel wird einmalig bei der Ausstellung angezeigt.
Jederzeit widerrufbar
Bitten Sie uns, einen Schlüssel zu widerrufen, und jede Anfrage mit diesem Schlüssel wird sofort abgelehnt. Lassen Sie vor der Rotation einen neuen Schlüssel ausstellen.
Mit Ratenbegrenzung
Jede Organisation hat Anfragelimits, damit ein außer Kontrolle geratenes Skript Ihre übrige Arbeit nicht ausbremst.
Ihre Daten bleiben Ihre Daten
Ein API-Schlüssel erreicht nur die Agenten und Dateien der eigenen Organisation. Es gelten dieselben Sicherheitskontrollen wie in der Compound App.
OpenAPI-Spezifikation
Die Spezifikation beschreibt alle Endpunkte und funktioniert mit jedem OpenAPI-Tool und jedem Client-Generator.
Häufig gestellte Fragen
Nein. Vereinbaren Sie eine Demo, dann aktiviert unser Team ein API-Konto für Ihre Organisation und stellt dessen Schlüssel aus.
So viele, wie Ihre Organisation benötigt. Üblich ist ein Agent pro Person in Ihrem Unternehmen, alle erstellt mit demselben Organisationsschlüssel.
Übergeben Sie beim Erstellen eines Agenten eine externe ID und filtern Sie beim Auflisten der Agenten danach. Compound speichert den Wert und interpretiert ihn nie.
Die CLI basiert auf derselben API, sodass Sie alles, was Sie in der CLI tun können, auch über HTTPS erledigen können. Personen können sich weiterhin mit ihrem eigenen Compound-Konto in der CLI anmelden.
Öffnen Sie den Ereignis-Stream eines Agenten. Er sendet zuerst einen Snapshot des aktuellen Zustands und danach ein Server-Sent Event für jede neue Nachricht, jede Aufgabenänderung, jeden Vorschlag und jeden Arbeitsschritt. Verbinden Sie sich mit dem zuletzt gelesenen Cursor neu, um dort weiterzumachen, wo Sie aufgehört haben.
Die API-Nutzung wird von den Compound-Credits Ihrer Organisation abgezogen. Preise und Limits vereinbaren wir mit Ihnen bei der Aktivierung Ihres Kontos.
Sprechen Sie mit uns über die API
Schildern Sie uns, was Sie entwickeln möchten. Wir richten Ihre Organisation ein und stellen Ihnen Ihre Schlüssel aus.