Prompts

Get prompt by id

Changed on

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}

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/prompts/{id}
  • Auth
    none declared

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

  • f59fc1819c0cRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 3953a50a6a0eRevision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from 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