Skip to navigation
API ReferencePromptsResponse format presets

Update a response format preset

When supplied, schema content is validated and preserved unchanged.

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

idstringRequired

Response-format preset ID.

Request

This endpoint expects an object.
namestringOptional>=1 character
response_format_contentstringOptional

JSON text preserved verbatim. It must decode to an object with a non-empty name and an object-valued schema.

is_enforcing_response_formatbooleanOptional

Response

Preset updated.
idstring
namestring
response_format_contentstring

JSON text preserved verbatim. It must decode to an object with a non-empty name and an object-valued schema.

is_enforcing_response_formatboolean
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error