コンテンツへスキップ
APIリファレンス
APIリファレンス

APIキーを作成する

標準APIキーを作成します。この操作で返されるプレーンテキストのキーは一度しか表示されないため、保存してください。

Markdownを表示

標準APIキーを作成します。この操作で返されるプレーンテキストのキーは一度しか表示されないため、保存してください。

エンドポイント

POST /api/v1/keys
ベースURL
https://runapi.ai
API バージョン
v1
認証
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Authorization
アカウント管理者の Management API キーが必要です。新しい標準 API キーは呼び出し元が所有します。
02

リクエスト

JSONボディ

指定されたリクエストの場所にのみ値を送信してください。

JSON ボディフィールド7件
allowed_modelsarray | null
任意

モデル識別子のオプション許可リスト。

credit_limit_centsinteger | null
任意

USD セント単位のオプションの支出上限。

credit_limit_reset_intervalstring | null
任意

キー支出上限のオプションのリセット周期。

許可される値: daily, weekly, monthly
credit_limit_windowsobject
任意

1h、1d、または 7d をキーとするローリング支出上限。各値には正の整数 limit_cents が含まれます。

enabledboolean
任意

このキーを使用したリクエストが受け付けられるかどうか。

デフォルト: true
guardrail_idstring
任意

作成時に添付するオプションのガードレールプレフィックスID。

namestring
任意

API キーのわかりやすい名前。

03

成功レスポンス

HTTP 201

POST /api/v1/keys

JSON 
{
  "allowed_models": [
    "gpt-5.4"
  ],
  "created_at": "2026-07-27T10:00:00.000Z",
  "credit_limit_cents": 1000,
  "credit_limit_reset_interval": "daily",
  "credit_limit_windows": {
    "1d": {
      "limit_cents": 500
    },
    "1h": {
      "limit_cents": 100
    },
    "7d": {
      "limit_cents": 2000
    }
  },
  "enabled": true,
  "guardrail_id": "guardrail_123",
  "id": "token_123",
  "key": "runapi_plaintext_example",
  "last_used_at": null,
  "masked_token": "runapi_abc...wxyz",
  "name": "Production"
}
04

エラーレスポンス (401)

HTTP 401
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Authentication required"
}
05

エラーレスポンス (403)

HTTP 403
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Management API key required"
}
06

エラーレスポンス (403)

HTTP 403
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Account admin required"
}
07

エラーレスポンス (400)

HTTP 400
レスポンススキーマ
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人が読めるエラーメッセージ。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人間が読める形式のバリデーションサマリー。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "公開リクエストフィールドをキーとするバリデーションメッセージ。各フィールドに対して人間が読める文字列の配列が含まれます。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

レスポンス例

JSON 
{
  "error": "page must be an integer"
}
08

エラーレスポンス (422)

HTTP 422
レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人間が読める形式のバリデーションサマリー。",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "公開リクエストフィールドをキーとするバリデーションメッセージ。各フィールドに対して人間が読める文字列の配列が含まれます。",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON 
{
  "error": "Validation failed",
  "errors": {
    "base": [
      "Validation failed"
    ]
  }
}
09

cURLの例

CURL 
curl -X POST https://runapi.ai/api/v1/keys \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production","credit_limit_cents":1000,"credit_limit_reset_interval":"daily","credit_limit_windows":{"1h":{"limit_cents":100},"1d":{"limit_cents":500},"7d":{"limit_cents":2000}},"allowed_models":["gpt-5.4"],"guardrail_id":"guardrail_123"}'