Skip to navigation
API ReferencePromptsResponse format presets

List response format presets

Returns the project’s saved response-format presets without schema content. Get a preset to retrieve its schema.

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.

Query parameters

pageintegerOptional>=1
page_sizeintegerOptional>=1
sort_bystringOptionalDefaults to -updated_at

Response

Paginated response-format presets.

countinteger

Number of results on this page, not the total. Request pages until next is null to get every result.

resultslist of objects
nextstring or nullOptional
previousstring or nullOptional
current_filtersmap from strings to anyOptional

Errors

403
Forbidden Error