公開 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