Search1API文档

OpenAPI 与 llms.txt

Search1API 的机器可读入口——供代码生成器使用的 OpenAPI schema,以及供 Agent 使用的 llms.txt。

借助机器可读入口,工具无需抓取渲染后的文档就能发现 Search1API。

OpenAPI schema

https://api.search1api.com/openapi.json

这是用于校验官方 SDK 的规范契约。你也可以用代码生成器基于它为其他语言生成更底层的客户端,或将其导入 Postman、Insomnia 等工具。

我们返回的每个响应也会通过带 rel="service-desc" 的 Link 头声明它——因此能识别链接关系的客户端可以自行找到该 schema。

llms.txt 文件

https://s1.dev/llms.txt

这是面向语言模型、覆盖整个产品的精选索引:产品概览、定价、文档、Agent 接入方式以及 OpenAPI schema,均以链接加一行说明的形式列出。

文档站还会发布两个基于当前 Fumadocs 源内容生成的文件:

产品级的 /llms-full.txt 会自动合并精选的产品索引、便于 Agent 读取的 /pricing.md 以及生成的完整文档。

如何选择

编写 TypeScript 或 Python 应用代码?使用官方 SDK。为其他语言生成客户端,或将 API 导入某个工具?使用 OpenAPI schema。帮助模型发现产品?使用根路径的 llms.txt。需要把文档作为上下文提供?使用 /docs/llms-full.txt 或合并后的根路径 /llms-full.txt。构建真正要调用 API 的 Agent?使用 MCP 服务器。

本页内容