Compound で開発する

API でできること

Compound CLI でできることはすべて HTTPS 経由でも利用でき、権限も結果も同じです。

最初のリクエスト

基本の流れは3つの呼び出しで完結します。ユーザー用のエージェントを作成し、メッセージを送り、進捗をストリーミングで受け取ります。

1. 1. 弊社が組織向けに発行した API キーを、プレースホルダーの代わりに設定してエクスポートします。

   export COMPOUND_API_KEY="<your-api-key>"

2. 2. エージェントを作成し、自社システムでそのユーザーに使っている ID を付けます。

   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. 3. エージェントにメッセージを送ります。

   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. 4. エージェントの作業中、そのイベントをストリーミングで受け取ります。

   curl -N https://ws.getcompound.ai/v1/agents/$AGENT_ID/events \
     -H "Authorization: Bearer $COMPOUND_API_KEY"

ご利用開始までの流れ

API へのアクセスはセルフサービスではありません。アカウント、課金、上限がお客様のご利用方法に合うよう、組織ごとに弊社チームと設定します。

1. 01

   デモを予約

   開発したい内容と、API を呼び出す人数またはシステム数をお知らせください。

2. 02

   組織を有効化します

   弊社チームがお客様のチームまたは会社用の API アカウントを作成し、上限と課金についてご相談のうえ決定します。

3. 03

   API キーをお渡しします

   組織用のキーを発行します。Authorization ヘッダーに Bearer トークンとして指定してください。

API キーは個人ではなく組織に紐づきます。1つのキーで社内の全ユーザー分のエージェントを作成でき、メンバーの入れ替わりがあってもキーは引き続き使えます。

セキュリティ