API ドキュメント

概要

APIキーを用意し、最初のリクエストを送信するまでをご案内します。

API のベース URL（エンドポイント）はご利用開始時に個別にご案内します。サンプル中の YOUR_API_BASE を、案内されたベース URL に置き換えてください。

認証

すべてのリクエストで、API キーを Authorization ヘッダーに Bearer トークンとして渡します。

HTTP header

Authorization: Bearer YOUR_API_KEY

キーの全文は API Keys ページでの発行時に一度だけ表示されます。再表示はできないため、安全な場所に保管してください。

死活監視用エンドポイント。認証は不要です。

GET /v1/health

curl

curl https://YOUR_API_BASE/v1/health

予測に利用できるモデルの一覧を返します。認証が必要です。

GET /v1/models

curl

curl https://YOUR_API_BASE/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

200 レスポンス

{
  "object": "list",
  "data": [
    {
      "id": "yoft",
      "version": "v1"
    }
  ]
}