API ReferenceTemporary API Keys

Retrieve an API key

Retrieve an API key by ID.

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Path parameters

idstringRequired
The ID of the temporary API key to retrieve.

Response

API key details.
idstring
API key ID.
namestring
Key name.
prefixstring
Key prefix.
is_testboolean
Test or production key.
expiry_datedatetime
Expiry date.
max_usageinteger

Max usage count. -1 = unlimited.

rate_limitinteger
Calls per minute.
spending_limitdouble
Spending limit in USD.
created_atdatetime

Errors

401
Unauthorized Error
404
Not Found Error