Create a new API key
Create a new API key for the authenticated user. The plaintext key is returned only in this response. Treat it as a write-only, sensitive value; it cannot be retrieved later. Management key required.
Authorizations
API key as bearer token in Authorization header
Body
Name for the new API key
1"My New API Key"
Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key.
1"user_2dHFtVWx2n56w6HkM0000000000"
Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected
"2027-12-31T23:59:59Z"
Whether to include BYOK usage in the limit
true
Optional spending limit for the API key in USD
50
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.
daily, weekly, monthly, null "monthly"
The workspace to create the API key in. Defaults to the default workspace if not provided.
"0df9e665-d932-5740-b2c7-b52af166bc11"
Response
API key created successfully
The created API key information
{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}The actual API key string (only shown once)
"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"