公开 API（/v1）

OpenAPI 规范

无需密钥即可获取的 OpenAPI 3.1 规范，可直接导入 GPT Actions、函数调用或代码生成器。

本页内容

获取规范
在 GPT Actions 中使用
生成客户端

获取规范#

GET/v1/openapi.json

OpenAPI 3.1 规范，无需密钥即可获取，可直接导入 GPT Actions 或函数调用工具：https://api.esimoa.com/v1/openapi.json

shell

curl https://api.esimoa.com/v1/openapi.json -o esimoa-openapi.json

注意

该规范与本文档是同一份约定。响应字段只会新增，名称与含义不会改变。规范缓存 1 小时。

在 GPT Actions 中使用#

若要通过自定义 GPT（Actions）连接，请从以下 URL 导入架构：https://api.esimoa.com/v1/openapi.json — 认证方式选择 API 密钥，自定义请求头名称为 X-API-Key。

生成客户端#

可使用标准 OpenAPI 工具生成类型或客户端代码。

shell

# TypeScript types
npx openapi-typescript https://api.esimoa.com/v1/openapi.json -o esimoa.d.ts

# Any language (Python, Go, Java, …)
npx @openapitools/openapi-generator-cli generate \
  -i https://api.esimoa.com/v1/openapi.json -g python -o ./esimoa-client

公开 API（/v1）

OpenAPI 规范

无需密钥即可获取的 OpenAPI 3.1 规范，可直接导入 GPT Actions、函数调用或代码生成器。

本页内容

获取规范
在 GPT Actions 中使用
生成客户端

获取规范#

GET/v1/openapi.json

OpenAPI 3.1 规范，无需密钥即可获取，可直接导入 GPT Actions 或函数调用工具：https://api.esimoa.com/v1/openapi.json

shell

curl https://api.esimoa.com/v1/openapi.json -o esimoa-openapi.json

注意

该规范与本文档是同一份约定。响应字段只会新增，名称与含义不会改变。规范缓存 1 小时。

在 GPT Actions 中使用#

若要通过自定义 GPT（Actions）连接，请从以下 URL 导入架构：https://api.esimoa.com/v1/openapi.json — 认证方式选择 API 密钥，自定义请求头名称为 X-API-Key。

生成客户端#

可使用标准 OpenAPI 工具生成类型或客户端代码。

shell

# TypeScript types
npx openapi-typescript https://api.esimoa.com/v1/openapi.json -o esimoa.d.ts

# Any language (Python, Go, Java, …)
npx @openapitools/openapi-generator-cli generate \
  -i https://api.esimoa.com/v1/openapi.json -g python -o ./esimoa-client