llms.txt 与 Markdown

CoinGlass API 文档可以被 AI 工具直接读取:llms.txt 是已公开文档的索引,任意文档页地址末尾加上 .md 就能拿到这一页的 Markdown 原文。把它们交给 AI 编程工具或知识库,回答会更准确。

本页要点
项目内容
简中文档索引https://docs.coinglass.com/v4.0-zh/llms.txt
英文文档索引https://docs.coinglass.com/llms.txt
单页原文任意文档页地址末尾加 .md;接口页的 Markdown 中包含该接口的 OpenAPI 定义
页面操作每个文档页标题右侧的「Copy Page」菜单,可复制本页、以 Markdown 查看,或在 ChatGPT、Claude 中打开
API Key读取文档不需要

两种读取方式

方式说明
llms.txt:文档索引列出已公开且未隐藏的文档页标题和地址,适合让 AI 先了解文档全貌,再按需读取具体页面。
https://docs.coinglass.com/v4.0-zh/llms.txt
.md:单页原文不含导航和样式的纯文本,接口页还包含 OpenAPI 定义,适合粘贴进对话或存入知识库。
https://docs.coinglass.com/v4.0-zh/reference/authentication.md
# 文档索引
curl https://docs.coinglass.com/v4.0-zh/llms.txt

# 单页 Markdown
curl https://docs.coinglass.com/v4.0-zh/reference/authentication.md

在文档页一键复制

每个文档页标题右侧都有「Copy Page」按钮和下拉菜单,不需要手动改地址:

按钮作用
Copy Page把本页内容复制下来,粘贴到 AI 对话中
View as Markdown在新标签页打开本页的 .md 原文
Open in ChatGPT / Open in Claude在对应的 AI 工具中打开本页,直接提问

常见用法

场景做法
AI 编程工具把 llms.txt 地址加入文档上下文,让它按最新接口写代码
AI 对话复制相关页面的 Markdown,连同你的问题一起发送
企业知识库定期抓取 llms.txt 中列出的 .md 页面,保持文档同步

语言版本

语言llms.txt 地址
简体中文https://docs.coinglass.com/v4.0-zh/llms.txt
繁體中文https://docs.coinglass.com/v4.0-zhtw/llms.txt
Englishhttps://docs.coinglass.com/llms.txt

常见问题

读取 llms.txt 需要 API Key 吗?

不需要。llms.txt 和 .md 页面是公开文档,只有调用数据接口时才需要 API Key。

文档更新后,llms.txt 会同步吗?

会。CoinGlass 文档使用 ReadMe 自动生成的 llms.txt,索引会随已发布文档的更新自动更新,无需手动维护。它列出页面标题和地址,不包含全部正文;具体接口内容请读取对应页面的 .md 版本。隐藏页面和未公开版本不会出现在公开索引中。

接口页的 .md 里有什么?

除了页面正文和返回示例,接口页的 Markdown 末尾还附有该接口的 OpenAPI 定义(参数、类型、响应结构),适合交给 AI 生成调用代码。

关于 llms.txt 与 AI 读取文档

什么是 llms.txt?

llms.txt 是专门给大语言模型阅读的文本索引,列出网站的重要页面及简介,帮助 AI 快速找到准确的文档内容。

如何把 CoinGlass 文档接入 RAG 知识库?

先抓取 llms.txt 获取页面清单,再逐个下载 .md 版本,按标题切分后写入向量数据库;定期重新抓取即可保持同步。

为什么 AI 写的 CoinGlass 代码会出错?

模型的训练数据里可能是旧版本接口。把 llms.txt 或相关页面的 Markdown 提供给 AI,它就能按 V4 的最新路径和参数生成代码。

相关文档