Prompts

Get a prompt version

Changed on

Get a specific prompt version by its ID.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/prompt-versions/{version_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/prompt-versions/{version_id}
  • Auth
    HTTP bearer

Path parameters

version_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique prompt version identifier (base64)

Response

A prompt version object

idstring required

The prompt version ID

prompt_idstring required

The prompt ID this version belongs to

commit_hashstring required

The commit hash of this version

commit_messagestring required

The commit message describing the changes in this version

input_variable_format'F_STRING' | 'MUSTACHE' | 'NONE' required

The format for input variables in the prompt messages. Defaults to F_STRING if not provided.

  • F_STRING: Single curly braces ({variable_name})
  • MUSTACHE: Double curly braces ({{variable_name}})
  • NONE: Deprecated. Treated as F_STRING. Will be removed in a future version.
provider'OPEN_AI' | 'AZURE_OPEN_AI' | 'AWS_BEDROCK' | 'VERTEX_AI' | 'ANTHROPIC' | 'CUSTOM' required

The LLM provider to use

modelstring required

The model to use for the call

created_atstring date-time required

When the version was created

created_by_user_idstring required

The user ID of the user who created this version

labelsstring[]

Label names currently pointing to this version (e.g., "production", "staging"). Labels are case-sensitive.

Changes

  • 9263b98aaefbRevision changes
    • info

      added the optional property ///// to the response with the status

  • 4f94eb2fd1abRevision changes
    • breaking

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

    • breaking

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

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new ANTHROPIC enum value to the response property for the response status

    • warning

      added the new ASSISTANT enum value to the // response property for the response status

    • warning

      added the new AWS_BEDROCK enum value to the response property for the response status

    • warning

      added the new AZURE_OPEN_AI enum value to the response property for the response status

    • warning

      added the new CUSTOM enum value to the response property for the response status

    • warning

      added the new FUNCTION enum value to the //// response property for the response status

    • warning

      added the new F_STRING enum value to the response property for the response status

    • warning

      added the new MUSTACHE enum value to the response property for the response status

    • warning

      added the new NONE enum value to the response property for the response status

    • warning

      added the new OPEN_AI enum value to the response property for the response status

    • warning

      added the new SYSTEM enum value to the // response property for the response status

    • warning

      added the new TOOL enum value to the // response property for the response status

    • warning

      added the new USER enum value to the // response property for the response status

    • warning

      added the new VERTEX_AI enum value to the response property for the response status

    • info

      api operation id prompt_versions_get removed and replaced with get_prompt_version

    • info

      removed the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the assistant enum value from the // response property for the response status

    • info

      removed the awsBedrock enum value from the response property for the response status

    • info

      removed the azureOpenAI enum value from the response property for the response status

    • info

      removed the custom enum value from the response property for the response status

    • info

      removed the f_string enum value from the response property for the response status

    • info

      removed the function enum value from the //// response property for the response status

    • info

      removed the mustache enum value from the response property for the response status

    • info

      removed the none enum value from the response property for the response status

    • info

      removed the openAI enum value from the response property for the response status

    • info

      removed the system enum value from the // response property for the response status

    • info

      removed the tool enum value from the // response property for the response status

    • info

      removed the user enum value from the // response property for the response status

    • info

      removed the vertexAI enum value from the response property for the response status