Skip to navigation
API ReferenceAdminTemporary API keys

Update a temporary API key

Update an API key’s name, expiry, usage, rate, or spending limit. With an API key you can change name and expiry_date. Changing max_usage, rate_limit, spending_limit or limit_policies needs the dashboard, or a key explicitly granted the limit_policies permission.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Path parameters

idstringRequired
The ID of the temporary API key to update.

Request

This endpoint expects an object.
namestringOptional
Key name.
expiry_datedatetimeOptional

Expiry date (ISO 8601).

max_usageintegerOptional

Maximum use count. -1 means unlimited.

rate_limitdouble or nullOptional
spending_limitdouble or nullOptional

Response

Updated API key.
idstringOptional
API key ID.
namestringOptional
Key name.
prefixstringOptional
Key prefix.
is_testbooleanOptional
Test or production key.
expiry_datedatetimeOptional
Expiry date.
max_usageintegerOptional

Max usage count. -1 = unlimited.

rate_limitdouble or nullOptional
Requests per minute. null uses the organization default.
spending_limitdouble or nullOptional

Spending limit in USD. null when not set.

createddatetimeOptional
When the API key was created.
unique_organization_idstring or nullOptional
Owning organization UUID.

Errors

403
Forbidden Error
404
Not Found Error