はじめに
Shannonはタスクの送信、結果のストリーミング、AIエージェントワークフローの管理のためのHTTP REST APIとgRPC APIを提供します。 ベースURL:http://localhost:8080(開発環境)
クイックスタート
APIエンドポイント
コアタスク操作
タスク制御
リアルタイムストリーミング
セッション管理
スケジュール(定期タスク)
認証
承認
OpenAI互換API
Shannonは既存のOpenAI SDKおよびツールとの簡単な統合のためにOpenAI互換APIを提供します。詳細はOpenAI互換APIリファレンスを参照してください。ヘルス&オブザーバビリティ
認証
開発デフォルト: 認証は無効(
GATEWAY_SKIP_AUTH=1)です。本番環境では有効にしてください。レスポンス形式
すべてのエンドポイントは一貫したエラー形式でJSONを返します: 成功(200):レート制限
- デフォルト: APIキーあたり60リクエスト/分
- ヘッダー:
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset - 429レスポンス:
Retry-Afterヘッダーを含む
イベントストリーミング
Shannonはリアルタイム監視のために33種類のイベントタイプを発行します: コアイベント:WORKFLOW_STARTED,WORKFLOW_COMPLETEDAGENT_STARTED,AGENT_COMPLETEDSTATUS_UPDATE,DATA_PROCESSINGERROR_OCCURRED
LLM_PROMPT,LLM_OUTPUT,LLM_PARTIAL
TOOL_INVOKED,TOOL_OBSERVATION
EventType列挙型を使用。SDKストリーミングを参照。
クライアントアクセス
Gateway REST APIまたはPython SDK(HTTPのみ)を使用:- RESTエンドポイント:
http://localhost:8080/api/v1/* - Python SDK:
ShannonClient(base_url="http://localhost:8080")
/v1/chat/completionsエンドポイントは互換性のためのものです。完全なShannon機能(スキル、セッションワークスペース、研究戦略)を使用するには、/api/v1/tasksおよび関連エンドポイントを使用してください。
ベストプラクティス
1. コンテキストのためにセッションIDを使用
2. 長時間タスクにはイベントをストリーム
3. レート制限を処理
4. 冪等性キーを使用
SDK
Python SDK
ストリーミング対応の公式Pythonクライアント
RESTクライアント
任意のHTTPクライアントライブラリを使用
次のステップ
タスク送信
タスク送信API
イベントストリーム
リアルタイムイベントストリーミング
セッションAPI
セッション管理
認証
APIキーとJWT認証
タスク制御
一時停止、再開、キャンセル
Python SDK
Pythonを始める