Create a new API key | OpenRouter

curl -X POST https://openrouter.ai/api/v1/keys \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Analytics Service Key",
  "expires_at": "2029-11-30T23:59:59Z",
  "include_byok_in_limit": false,
  "limit": 100,
  "limit_reset": "weekly"
}'

{
  "data": {
    "byok_usage": 12,
    "byok_usage_daily": 1,
    "byok_usage_monthly": 45,
    "byok_usage_weekly": 10,
    "created_at": "2024-06-15T09:00:00Z",
    "creator_user_id": "user_7a9XvLq3pZ8bN1cD0000000000",
    "disabled": false,
    "hash": "a3f5b7c9d8e1f23456789abcdef0123456789abcdef0123456789abcdef0123",
    "include_byok_in_limit": false,
    "label": "sk-or-v1-analytics-1a2b3c",
    "limit": 100,
    "limit_remaining": 88,
    "limit_reset": "weekly",
    "name": "Analytics Service Key",
    "updated_at": "2024-06-20T14:45:00Z",
    "usage": 12,
    "usage_daily": 1,
    "usage_monthly": 50,
    "usage_weekly": 12,
    "workspace_id": "3f9e665d-d932-5740-b2c7-b52af166bc11",
    "expires_at": "2029-11-30T23:59:59Z"
  },
  "key": "sk-or-v1-7b8c9d0e1f2a3b4c5d6e7f8091a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b"
}

Create a new API key for the authenticated user. Management key required.

Authentication

AuthorizationBearer

API key as bearer token in Authorization header

Request

This endpoint expects an object.

namestringRequired>=1 character

Name for the new API key

creator_user_idstring or nullOptional>=1 character

Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.

expires_atdatetime or nullOptional

Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected

include_byok_in_limitbooleanOptional

Whether to include BYOK usage in the limit

limitdouble or nullOptional

Optional spending limit for the API key in USD

limit_resetenum or nullOptional

Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday.

Allowed values:

workspace_idstringOptionalformat: "uuid"

The workspace to create the API key in. Defaults to the default workspace if not provided.

Response

API key created successfully

dataobject

The created API key information

keystring

The actual API key string (only shown once)

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error