KEkeywordsai
Prompts

Get a response format preset

Changed on

Retrieve the complete saved response-format schema text.

get/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.

Response

Response-format preset.

idstring required
namestring required
created_atstring date-time required
updated_atstring date-time 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

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from no type to object for status

    • info

      api operation id prompts_api_response_format_presets_retrieve removed and replaced with api_response_format_presets_retrieve

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Prompts added

    • info

      api tag prompts removed

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed subschema #2 from the response property oneOf list for the response status

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status