Skip to navigation
API ReferencePromptsResponse format presets

Create a response format preset

Stores JSON-schema text in the caller’s project as a JSON string, validated without reformatting. The server sets the project and creator.

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.

Request

This endpoint expects an object.
namestringRequired>=1 character
response_format_contentstringRequired

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

is_enforcing_response_formatbooleanOptionalDefaults to false

Response

Preset created.
idstring
namestring
projectstring

Server-stamped project UUID.

created_byinteger or null

Server-stamped creator user ID.

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

Errors

400
Bad Request Error
403
Forbidden Error