AI 版本 (llms.txt)
ProxyHat 发布了本文档的机器可读版本,让 AI 助手能够直接阅读并推理这套 API。如果你使用 Claude、Cursor、Codex 或其他任何基于 LLM 的工具来构建集成,只需把这些文件交给它,它就能完整、准确地掌握 API 的全貌,无需猜测。
把完整的 API 交给你的 AI
一键复制完整文档,外加一段简短说明,告诉你的助手如何使用这些内容——就像安装一项技能。把它粘贴到新对话中,AI 就掌握了整个 ProxyHat API。
适用于 Claude、ChatGPT、Cursor、Codex、Gemini 以及其他任何 AI 助手。
两个文件,同一约定。ProxyHat 遵循 llmstxt.org 约定。
/llms.txt 是一份精炼、人工整理的索引,列出所有文档页面的链接。/llms-full.txt 则是将全部文档合并成的单个自包含 Markdown 文件——助手需要的一切,一次粘贴即可拥有。
这两个文件
链接索引——一个简短的 Markdown 文件,列出每个文档页面的一句话摘要及其 URL。体积小到可以常驻助手的上下文中;模型按需抓取各个页面。
https://docs.proxyhat.com/llms.txt
完整文档——所有页面拼接成的单个 Markdown 文档。无需跟随链接,也无需抓取:粘贴一次,助手就掌握了整个 API。
https://docs.proxyhat.com/llms-full.txt
如何在你的工具中使用
以下两种方式适用于所有工具:
- 直接粘贴。点击上方的“复制给 AI”(或打开
https://docs.proxyhat.com/llms-full.txt并复制整个文件),然后粘贴到助手的对话或上下文/规则文件中。最适合无法联网的工具。 - 提供 URL。把
https://docs.proxyhat.com/llms.txt或https://docs.proxyhat.com/llms-full.txt这两个 URL 交给你的工具,让它自行抓取。最适合具备网页或文件抓取能力的工具。
各工具使用要点
- Claude / Claude Code——把
llms-full.txt的内容粘贴到对话中,或将 URL 添加到项目的CLAUDE.md,这样每次会话都会自动加载。Claude Code 也可以直接用其网页工具抓取该 URL。 - Codex——把 URL 或粘贴的内容放进你的
AGENTS.md(或提示词)中,让智能体在编写集成时随时参考。 - Cursor——在 Settings → Indexing & Docs(Add new doc)中添加
https://docs.proxyhat.com/llms-full.txt,或将该文件粘贴到.cursorrules/ 项目规则中。 - Kimi——把
llms-full.txt的内容粘贴到对话中,或分享 URL 并让它先读取该文件。 - OpenCode——在你的智能体配置/规则文件中引用该 URL,或将完整文件粘贴到上下文中。
- 其他任意 LLM——方法都一样:使用“复制给 AI”按钮,把
llms-full.txt的内容粘贴给你的助手,或让工具直接访问上面的 URL。
AI 能学到什么
通过这些文件,助手可以获得编写可用集成所需的全部信息,包括:
- 基础 URL——所有请求都发送到
https://api.proxyhat.com/v1。 - 身份认证——如何获取 API 密钥,并以
Authorization: Bearer <key>的形式发送。 - 子用户模型——子用户、分组和预设如何映射到代理访问权限。
- 代理连接字符串——用户名语法(国家、会话、轮换以及 AI 过滤定向),以及如何构建或获取开箱即用的连接字符串。
- 分销商流程——如何代表你自己的客户开通和管理代理。
- 响应结构——哪些端点使用标准的
{success, payload, meta, errors, description}信封结构,哪些返回扁平对象,全程附带真实字段名。
始终保持最新。这两个文件与你正在阅读的页面由同一数据源生成,因此基于它们工作的助手始终与线上 API 保持同步。拿不准时,优先使用
llms-full.txt——它完整且自包含。