Prompts

Get prompt by id

Get prompt by id; when mask_id or environment is provided, requestedVersion is populated with the resolved version. mask_id and environment are mutually exclusive.

get/v1/private/prompts/{id}

Path parameters

idstring uuid required

Query parameters

mask_idstring uuid

Optional mask version id; when set, requestedVersion is the mask row for that id

environmentstring

Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt

Response

Prompt resource

idstring uuid
namestring required
project_idstring uuid

Project ID. Takes precedence over project_name when both are provided.

descriptionstring
template_structure'text' | 'chat'

Template structure type: 'text' or 'chat'. Immutable after creation.

tagsstring[]
created_atstring date-time
created_bystring
last_updated_atstring date-time
last_updated_bystring
version_countinteger

Changes

Changed in 6 of the 58 revisions of this API.1618

    • added the optional property latest_version/environment to the response with the 200 status

      response-optional-property-added

    • added the optional property requested_version/environment to the response with the 200 status

      response-optional-property-added

  • 3953a50a6a0e22See the full diff
    • removed the optional property latest_version/environment from the response with the 200 status

      response-optional-property-removed

    • removed the optional property requested_version/environment from the response with the 200 status

      response-optional-property-removed

    • added the optional property latest_version/environments to the response with the 200 status

      response-optional-property-added

    • added the optional property requested_version/environments to the response with the 200 status

      response-optional-property-added

    • added the optional property latest_version/version_number to the response with the 200 status

      response-optional-property-added

    • added the optional property requested_version/version_number to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter environment

      new-optional-request-parameter

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the optional property latest_version/environment to the response with the 200 status

      response-optional-property-added

    • added the optional property requested_version/environment to the response with the 200 status

      response-optional-property-added

  • f93aac27fb6e34See the full diff
    • removed the optional property code from the response with the 404 status

      response-optional-property-removed

    • removed the optional property details from the response with the 404 status

      response-optional-property-removed

    • removed the optional property message from the response with the 404 status

      response-optional-property-removed

    • added the new optional query request parameter mask_id

      new-optional-request-parameter

    • added the optional property errors to the response with the 404 status

      response-optional-property-added

    • added the optional property latest_version/version_type to the response with the 200 status

      response-optional-property-added

    • added the optional property requested_version/version_type to the response with the 200 status

      response-optional-property-added

  • d606e84c75e4114See the full diff
    • deleted the query request parameter environment

      request-parameter-removed

    • deleted the query request parameter mask_id

      request-parameter-removed

    • removed the optional property errors from the response with the 404 status

      response-optional-property-removed

    • removed the optional property latest_version/environment from the response with the 200 status

      response-optional-property-removed

    • removed the optional property latest_version/environments from the response with the 200 status

      response-optional-property-removed

    • removed the optional property latest_version/version_number from the response with the 200 status

      response-optional-property-removed

    • removed the optional property latest_version/version_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property requested_version/environment from the response with the 200 status

      response-optional-property-removed

    • removed the optional property requested_version/environments from the response with the 200 status

      response-optional-property-removed

    • removed the optional property requested_version/version_number from the response with the 200 status

      response-optional-property-removed

    • removed the optional property requested_version/version_type from the response with the 200 status

      response-optional-property-removed

    • removed the non-success response with the status 400

      response-non-success-status-removed

    • added the optional property code to the response with the 404 status

      response-optional-property-added

    • added the optional property details to the response with the 404 status

      response-optional-property-added

    • added the optional property message to the response with the 404 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog