4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
prompts

Create a response-format preset

Save JSON-schema text in the caller's project. The content remains a JSON string and is validated without reformatting. Project and creator are server stamped.

post/api/response-format-presets/

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 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

Response

Preset created.

idstring required
namestring required
projectstring required

Server-stamped project UUID.

created_byinteger nullable required

Server-stamped creator user ID.

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