Create a new version of an existing prompt.
Payload Requirements
commit_message is required.messages.id, commit_hash, created_at, created_by_user_id.
Requests that contain these fields will be rejected.input_variable_format and provider are required.Valid example (create)
{
"commit_message": "Updated system prompt for better responses",
"input_variable_format": "f_string",
"provider": "openAI",
"model": "gpt-4",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello, {name}!"
}
]
}
Invalid example (missing required commit_message)
{
"input_variable_format": "f_string",
"provider": "openAI",
"messages": [
{
"role": "user",
"content": "Hello!"
}
]
}
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
The unique identifier of the prompt A universally unique identifier
"RW50aXR5OjEyMzQ1"
Body containing prompt version creation parameters
Commit message describing this version
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 parsingf_string, mustache, none The LLM provider to use
openAI, azureOpenAI, awsBedrock, vertexAI, custom The messages that make up the prompt template
1The model to use for the call. Optional. If omitted, no default model is set on the version.
Parameters for the LLM invocation. Optional. Defaults to empty (no invocation parameters).
Provider-specific parameters. Optional. Defaults to empty (no provider-specific parameters).
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.
The prompt version ID
The prompt ID this version belongs to
The commit hash of this version
The commit message describing the changes in this version
The messages that make up the prompt template
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 parsingf_string, mustache, none The LLM provider to use
openAI, azureOpenAI, awsBedrock, vertexAI, custom The model to use for the call
When the version was created
The user ID of the user who created this version
Parameters for the LLM invocation
Provider-specific parameters
Tool configuration for the LLM invocation
Label names currently pointing to this version (e.g., "production", "staging")