Skip to main content
GET
/
v2
/
prompt-versions
/
{version_id}
Get a prompt version
curl --request GET \
  --url https://api.arize.com/v2/prompt-versions/{version_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "pv_001",
  "prompt_id": "prompt_001",
  "commit_hash": "abc123def456",
  "commit_message": "Updated system prompt",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "Hello, {name}!"
    }
  ],
  "input_variable_format": "f_string",
  "provider": "openAI",
  "model": "gpt-4",
  "invocation_params": {
    "temperature": 0.7,
    "max_tokens": 1000
  },
  "provider_params": {},
  "created_at": "2024-01-02T12:00:00Z",
  "created_by_user_id": "user_12345"
}

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

version_id
string
required

The unique identifier of the prompt version A universally unique identifier

Example:

"RW50aXR5OjEyMzQ1"

Response

A prompt version object

A prompt version represents a specific snapshot of a prompt's configuration. Each version captures the messages, model settings, and parameters at a point in time. Versions are immutable once created and are identified by a commit hash.

id
string
required

The prompt version ID

prompt_id
string
required

The prompt ID this version belongs to

commit_hash
string
required

The commit hash of this version

commit_message
string
required

The commit message describing the changes in this version

messages
object[]
required

The messages that make up the prompt template

input_variable_format
enum<string>
required

The format for input variables in the prompt messages. There is no default; this field is required.

  • f_string: Single curly braces ({variable_name})
  • mustache: Double curly braces ({{variable_name}})
  • none: No input variable parsing
Available options:
f_string,
mustache,
none
provider
enum<string>
required

The LLM provider to use

Available options:
openAI,
azureOpenAI,
awsBedrock,
vertexAI,
custom
model
string
required

The model to use for the call

created_at
string<date-time>
required

When the version was created

created_by_user_id
string
required

The user ID of the user who created this version

invocation_params
object

Parameters for the LLM invocation

provider_params
object

Provider-specific parameters

tool_config
object

Tool configuration for the LLM invocation

labels
string[]

Label names currently pointing to this version (e.g., "production", "staging")