概要
Shannon REST APIはHTTPベースのインターフェースでタスクの送信と管理を提供します。Shannonは40以上のRESTエンドポイントを8つのカテゴリに分けて提供しています。エンドポイント
タスク送信
新しいタスクを送信
ステータス取得
タスクステータスを取得
タスク一覧
すべてのタスクを一覧表示
タスクキャンセル
実行中のタスクをキャンセル
タスク一時停止
タスクを一時停止
タスク再開
一時停止したタスクを再開
タスク承認
承認待ちタスクを承認
セッション
セッション管理
ストリーミング
リアルタイムイベントストリーミング
認証
API認証
スケジュール（定期タスク）
| エンドポイント | メソッド | 説明 |
|---|---|---|
/api/v1/schedules | POST | 新しいスケジュールを作成 |
/api/v1/schedules | GET | スケジュール一覧を取得 |
/api/v1/schedules/{id} | GET | スケジュール詳細を取得 |
/api/v1/schedules/{id}/runs | GET | スケジュール実行履歴を取得 |
/api/v1/schedules/{id} | PUT | スケジュール設定を更新 |
/api/v1/schedules/{id}/pause | POST | スケジュールを一時停止 |
/api/v1/schedules/{id}/resume | POST | スケジュールを再開 |
/api/v1/schedules/{id} | DELETE | スケジュールを削除 |
OpenAI互換API
ShannonはOpenAI互換APIを提供し、既存ツールとの統合を容易にします：| エンドポイント | メソッド | 説明 |
|---|---|---|
/v1/chat/completions | POST | チャット補完（ストリーミング対応） |
/v1/models | GET | 利用可能なモデル一覧 |
/v1/models/{model} | GET | 特定モデルの詳細 |
認証（8エンドポイント）
| エンドポイント | メソッド | 説明 |
|---|---|---|
/auth/register | POST | 新規ユーザー登録 |
/auth/login | POST | ログインしてトークンを取得 |
/auth/refresh | POST | アクセストークンを更新 |
/auth/me | GET | 現在のユーザー情報を取得 |
/auth/api-keys/refresh | POST | APIキーを更新 |
/auth/api-keys | GET | APIキー一覧を取得 |
/auth/api-keys | POST | 新しいAPIキーを作成 |
/auth/api-keys/{id} | DELETE | APIキーを無効化 |
承認とHITLレビュー（3エンドポイント）
| エンドポイント | メソッド | 説明 |
|---|---|---|
/approvals/decision | POST | 人間の承認決定を送信 |
/tasks/{id}/review | GET | HITLレビューの詳細を取得 |
/tasks/{id}/review | POST | HITLレビューの決定を送信 |
次のステップ
クイックスタート
最初のタスクを送信
Python SDK
Python SDKを使用