> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shannon.run/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

> Shannon REST APIリファレンス

## 概要

Shannon REST APIはHTTPベースのインターフェースでタスクの送信と管理を提供します。Shannonは**40以上のRESTエンドポイント**を8つのカテゴリに分けて提供しています。

## エンドポイント

<CardGroup cols={2}>
  <Card title="タスク送信" icon="paper-plane" href="/ja/api/rest/submit-task">
    新しいタスクを送信
  </Card>

  <Card title="ステータス取得" icon="circle-info" href="/ja/api/rest/get-status">
    タスクステータスを取得
  </Card>

  <Card title="タスク一覧" icon="list" href="/ja/api/rest/list-tasks">
    すべてのタスクを一覧表示
  </Card>

  <Card title="タスクキャンセル" icon="xmark" href="/ja/api/rest/cancel-task">
    実行中のタスクをキャンセル
  </Card>

  <Card title="タスク一時停止" icon="pause" href="/ja/api/rest/pause-task">
    タスクを一時停止
  </Card>

  <Card title="タスク再開" icon="play" href="/ja/api/rest/resume-task">
    一時停止したタスクを再開
  </Card>

  <Card title="タスク承認" icon="check" href="/ja/api/rest/approve-task">
    承認待ちタスクを承認
  </Card>

  <Card title="セッション" icon="comments" href="/ja/api/rest/sessions">
    セッション管理
  </Card>

  <Card title="ストリーミング" icon="stream" href="/ja/api/rest/streaming">
    リアルタイムイベントストリーミング
  </Card>

  <Card title="認証" icon="key" href="/ja/api/rest/authentication">
    API認証
  </Card>
</CardGroup>

## スケジュール（定期タスク）

| エンドポイント                         | メソッド   | 説明            |
| ------------------------------- | ------ | ------------- |
| `/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レビューの決定を送信 |

## 次のステップ

<CardGroup cols={2}>
  <Card title="クイックスタート" icon="rocket" href="/ja/quickstart/quickstart">
    最初のタスクを送信
  </Card>

  <Card title="Python SDK" icon="python" href="/ja/sdk/python/quickstart">
    Python SDKを使用
  </Card>
</CardGroup>