Skip to main content

​
面向 AI 的文档：将 Sorsa API 文档用于 LLM

Sorsa 文档专为 AI 助手和大语言模型使用而设计。你可以将完整 API 参考直接提供给 ChatGPT、Claude、Grok、Cursor、Copilot 或其他 LLM，以获得准确回答、生成集成代码并排查问题，无需手动逐页阅读文档。

​
AI 文档文件

我们维护一个机器可读文件 sorsa_api_v3_documentation_en.txt，集中包含完整 Sorsa API 规范：每个端点、参数、响应结构和身份验证细节。 https://api.sorsa.io/v3/static/sorsa_api_v3_documentation_en.txt 请附上此文件或将其加入项目上下文。如果超出工具的上下文容量，可使用文档索引选择当前任务需要的端点和通用机制页面。

​
使用方法

ChatGPT / Claude / Grok / Gemini： 在对话开始时复制文件内容，或将文件作为附件上传，然后提问，例如“编写一个 Python 脚本，搜索关于 AI 的推文并导出到 CSV”或“如何分页获取账号的全部粉丝？” Cursor / Copilot / Claude Code / Codex / Windsurf： 将文件加入项目上下文或在提示词中引用。要求助手使用文档列出的端点 URL、参数、请求头和响应结构。将生成的代码与端点参考进行核对，并在批量运行前先测试一个小请求。 自定义 GPT 与助手： 构建需要通过 Sorsa 处理 X/Twitter 数据的自定义 GPT 或 AI 助手时，将此文件作为知识文件上传。

​
文件包含什么？

该文件是整个 API 的结构化参考：
  • 基础 URL、身份验证方式和常见错误码
  • 共享数据模型（User、Tweet、Follower、Space 等），包含每个字段名称和类型
  • 按类别分组的全部端点路径，以及各自的 HTTP 方法、必选参数和可选参数
  • 每个端点的请求和响应示例
  • 分页行为、排序选项、每次请求上限和日期格式
  • 支持的搜索语法，包括常用运算符和完整运算符参考链接
  • 边界情况和特殊响应格式，例如 Tweet 与 Article 对象的字段名差异（如 view_count 与 views_count）
文件会随 API 演进而持续更新，确保提供当前规范。

​
为什么这很重要？

LLM 的表现取决于所提供的上下文。缺乏准确 API 文档时，AI 助手可能猜测参数名、虚构响应字段或使用过时方式。提供参考文档可以减少猜测，但生成的代码仍需验证。使用前请检查 HTTP 方法、请求字段、响应包装结构、分页和错误处理。

​
后续步骤

运行 AI 助手生成的代码需要 API 密钥。每个新账号均包含 100 次免费请求，无需信用卡，因此可以立即测试生成的代码。