KEkeywordsai
Prompts

Update a response format preset

Changed on

When supplied, schema content is validated and preserved unchanged.

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

Request

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

Path parameters

idstring required

Response-format preset ID.

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

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • info

      api operation id prompts_api_response_format_presets_partial_update removed and replaced with api_response_format_presets_partial_update

    • 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