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

# AI向けドキュメント

# AI向けドキュメント：Sorsa APIの資料をLLMで活用する

Sorsaのドキュメントは、AIアシスタントや大規模言語モデルで活用できるように作られています。APIリファレンス全体をChatGPT、Claude、Grok、Cursor、CopilotなどのLLMに渡すことで、資料を1ページずつ読むことなく、正確な回答の取得、連携コードの生成、問題の調査を進められます。

***

## AI向けのドキュメントファイル

機械可読の単一ファイル`sorsa_api_v3_documentation_en.txt`には、Sorsa APIの完全な仕様がまとめられています。すべてのエンドポイント、パラメーター、レスポンススキーマ、認証の詳細を1か所で確認できます。

[https://api.sorsa.io/v3/static/sorsa\_api\_v3\_documentation\_en.txt](https://api.sorsa.io/v3/static/sorsa_api_v3_documentation_en.txt)

ファイルを添付するか、プロジェクトのコンテキストに追加してください。ツールのコンテキスト上限を超える場合は、[ドキュメントの索引](https://docs.sorsa.io/llms.txt)から、作業に必要なエンドポイントと共通の仕組みのページを選びます。

***

## 使い方

**ChatGPT / Claude / Grok / Gemini：** 会話の最初にファイルの内容を貼り付けるか、ファイルを添付します。その後、「AIに関するツイートを検索してCSVに出力するPythonスクリプトを書いて」や「アカウントの全フォロワーをページネーションで取得するには？」などと質問してください。

**Cursor / Copilot / Claude Code / Codex / Windsurf：** ファイルをプロジェクトのコンテキストに追加するか、プロンプトから参照します。資料に記載されたエンドポイントURL、パラメーター、ヘッダー、レスポンススキーマを使うよう指示してください。生成されたコードをエンドポイントの仕様と照合し、バッチ処理を実行する前に少量のリクエストでテストします。

**カスタムGPT・アシスタント：** Sorsa経由でX/Twitterデータを扱うカスタムGPTやAIアシスタントを作る場合は、ナレッジファイルとしてアップロードします。

***

## ファイルに含まれる内容

API全体の仕様を構造化してまとめています。

* ベースURL、認証方法、共通のエラーコード
* すべてのフィールド名と型を含む共通データモデル（User、Tweet、Follower、Spaceなど）
* カテゴリー別の全エンドポイントパス、HTTPメソッド、必須・任意のパラメーター
* 各エンドポイントのリクエストとレスポンスの例
* ページネーション、並び順、1リクエストあたりの制限、日付形式
* 一般的な検索演算子と完全な演算子リファレンスへのリンクを含む検索構文
* TweetとArticleのフィールド名の違い（例：`view_count`と`views_count`）など、例外的なケースや特殊なレスポンス形式

APIの変更に合わせて更新されるため、常に現在の仕様を参照できます。

***

## この資料が重要な理由

LLMの回答品質は、与えられたコンテキストに左右されます。正確なAPI資料がないと、AIアシスタントはパラメーター名を推測したり、存在しないレスポンスフィールドや古い実装パターンを使ったりします。リファレンスを渡すことで推測は減りますが、生成されたコードの検証は必要です。使用前にHTTPメソッド、リクエストのフィールド、レスポンスのラッパー、ページネーション、エラー処理を確認してください。

***

## 次のステップ

AIアシスタントが生成したコードを実行するにはAPIキーが必要です。新規アカウントにはクレジットカード不要の無料リクエスト100件が含まれるため、すぐにコードを試せます。

* [クイックスタート](https://docs.sorsa.io/ja/quickstart)：APIキーを取得して最初のリクエストを送信
* [認証](https://docs.sorsa.io/ja/authentication)：リクエストにAPIキーを渡す方法
* [APIリファレンス](https://docs.sorsa.io/ja/api-reference-guide)：同じ仕様をページ形式で参照