4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
prompts

Update a response-format preset

Partially update a preset. When supplied, schema content is validated and preserved verbatim.

patch/api/response-format-presets/{id}/

Path parameters

idstring required

Response-format preset ID.

Headers

Authorizationstring required

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.

Request body

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

Response

Preset updated.

idstring required
namestring required
response_format_contentstring required

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

is_enforcing_response_formatboolean required
created_atstring date-time required
updated_atstring date-time required