RErespan
Prompts

Create a response format preset

Changed on

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

post/api/response-format-presets/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/response-format-presets/
  • Auth
    • HTTP bearer
    • or HTTP bearer

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

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • breaking

      the response property became nullable for the status

    • info

      api operation id prompts_api_response_format_presets_create removed and replaced with api_response_format_presets_create

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Prompts added

    • info

      api tag prompts removed

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status