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, 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 retrieve.

Response

API key details.
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_limitdoubleOptional
Spending limit in USD.
createddatetimeOptional
When the API key was created.
unique_organization_idstring or nullOptional
Owning organization UUID.

Errors

401
Unauthorized Error
404
Not Found Error