OpenAPI 和 llms.txt
机器可读的 API 描述。
两个文件以机器可读的形式描述 API:openapi.json 用于代码生成器和 API 客户端,llms.txt 用于 AI 智能体。
openapi.json
OpenAPI 3.0 格式的规范描述了各端点及其主要参数、响应、错误和身份验证。它也涵盖 Webhook 投递的事件。所有细节以本文档为准。
URL
https://handelsregister.ai/openapi.json
使用方式:
- 使用 OpenAPI Generator 等生成器,为你的语言创建带类型的客户端。
- 将文件导入 Postman、Insomnia 或 Bruno,即可立即使用所有请求。
- 智能体框架可根据该文件为语言模型生成工具定义。
在浏览器中打开该 URL,保存文件并导入。
在版本 1 中,会新增字段和取值,现有的保持不变。请让你的客户端忽略未知字段。详见更新日志。
llms.txt
llms.txt 以简短文本为语言模型概括 API:端点、参数、功能、价格和最重要的规则。
URL
https://handelsregister.ai/llms.txt
在你的 AI 智能体为 API 编写代码之前,把这个 URL 交给它。这样它就知道真实的参数名称和响应字段。