ドキュメント

# ドキュメント

各ガイドでは、クライアントがOneSay Control API、タスク音声、リアルタイム音声（RTC）、およびルーム、ソース、SignalStream、タスク、アーティファクトの各リソースをどう使うかを説明します。ガイドと生成されたリファレンスが異なる場合は、リファレンスに従ってください。JavaScript SDKとESP32 SDKは、どちらもまだパッケージレジストリに公開されていません。

## クイックスタート

- [JavaScriptクイックスタート](JAVASCRIPT_QUICKSTART.md)：インストール済みのパッケージを使った、タスク音声（自分で用意した音声を入力し、OneSay Realtime WebSocket経由でタスクの結果を受け取る）とRTC（パブリケーション、サブスクリプション、データ、RPC、明示的なAgent）。
- [ESP32クイックスタート](ESP32_QUICKSTART.md)：ESP-IDFアプリケーションからのタスク音声と、RTCコンポーネント。アプリケーションのビルドまでを扱い、ボードへの書き込みとプロビジョニングは対象外です。
- [複数人の音声ルーム](MULTI_PARTY_VOICE_ROOM.md)：3〜4人がブラウザーから1つの音声ルームで話すための、JavaScript SDKを使った手順と、プレビューの現在の制限。

## SDKリファレンス

- [APIリファレンス](../reference/generated/public-api.md)：Control APIの各オペレーションと、そのリクエストとレスポンスのフィールド、例、エラー。
- [JavaScript SDKリファレンス](../reference/generated/javascript-sdk-draft.md)：環境、タスクとRTCのエントリポイント、セッションの状態、宣言済みのケイパビリティ。
- [ESP32 SDKリファレンス](../reference/generated/esp32-sdk.md)：コンポーネント、タスクとRTCのエントリポイント、制限事項を含む宣言済みのケイパビリティ。
- [SDKのケイパビリティと互換性](../reference/generated/sdk-compatibility.md)：両SDKのサポートマトリックス、未サポートおよび非公開のエントリ、RTCのライフサイクル、タスクのリカバリ、制限とプライバシー。
- [正規リファレンス](../reference/generated/catalog.md)：公開APIのオペレーション、イベント、グラント、エラー。

## AIクライアントと診断

- [MCPガイド](MCP_GUIDE.md)：AIクライアント向けのOneSay MCPサーバー。サインイン、ツール、リソース、プロンプトを説明します。
- [デバイス診断](DEVICE_DIAGNOSTICS.md)：デバイスの状態と、デバイスが属するプロジェクト環境の開発者向けの安全なログ。

## セキュリティとID

- [認証情報の安全性](CREDENTIAL_SAFETY.md)：ブラウザー、サーバー、デバイスの境界。
- 認証：ユーザーは認可コードとPKCEでサインインし、サーバーは環境に紐づくAPIキーまたはサービスプリンシパルのトークンを使い、デバイスはそれぞれ固有のデバイス認証情報を使います。
- APIキー：プレフィックスはキーの所属先を示します（Stagingでは`osp_stg_`、本番環境のTestとLiveでは`osp_test_`と`osp_live_`）。プレフィックスはヒントであり、権限ではありません。キーは一度だけ表示され、失効はリクエストのたびに確認されます。
- デバイスプロビジョニング：5分間有効な使い捨てのプロビジョニングコードを使い、その後デバイスはデバイスごとのシークレットを短期アクセストークンと交換します。リアルタイム接続には、これとは別に、60秒間有効な使い捨ての接続チケットを使います。
- 認可：各リソースのプロジェクトと環境はサーバーが決定します。グラントは明示的に付与され、拒否が常に優先されます。認証情報のスコープでグラントを狭めることはできても、広げることはできません。