公開API(/v1)
OpenAPI 仕様
キーなしで取得できるOpenAPI 3.1仕様 — GPT Actions・関数呼び出し・コード生成にそのまま取り込めます。
このページの内容
仕様を取得#
GET
/v1/openapi.jsonOpenAPI 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