API ReferenceCaches

Retrieve a cached response

Retrieve a cached response by its organization-scoped cache key. API-key responses omit internal numeric IDs.

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.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

cache_keystringRequired

Organization-scoped cache key returned by the cache list endpoint.

Response

Cached response details.
cache_keystring

Organization-scoped public cache key.

prompt_contentstring
Prompt text extracted from the cached request.
response_contentstring
Response text extracted from the cached response.
hit_countinteger
Live cache hit count enriched from ClickHouse.
timestampdatetime
When the cache entry was created.
updated_atdatetime
When the cache entry was last updated.
idintegerOptional

Internal numeric ID. Present only for dashboard-JWT responses.

request_contentstringOptional
Stored request text preview. The current backend serializer truncates this field to roughly the first 100 characters.
prompt_messageslist of objectsOptional
Original prompt message array stored with the cache entry.
full_responseobjectOptional
Full cached provider response object.
response_timedoubleOptional
Stored response time for the cached entry, in seconds.
expiry_datedatetime or nullOptional

When the cache entry expires. null means no expiry date is set.

Errors

401
Unauthorized Error
404
Not Found Error