REST API
curl --request POST \
--url https://api.arize.com/v2/prompts/{prompt_id}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_message": "Updated system prompt for better responses",
"input_variable_format": "f_string",
"provider": "open_ai",
"model": "gpt-4",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello, {name}!"
}
]
}
'{
"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": "open_ai",
"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"
}Create a prompt version
Create a new version of an existing prompt.
Payload Requirements
- A
commit_messageis required. - At least one message is required in
messages. - Do not include system-managed fields on input:
id,commit_hash,created_at,created_by_user_id. Requests that contain these fields will be rejected. provideris required.input_variable_formatdefaults tof_stringif not provided.
Valid example (create)
{
"commit_message": "Updated system prompt for better responses",
"input_variable_format": "f_string",
"provider": "open_ai",
"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": "open_ai",
"messages": [
{
"role": "user",
"content": "Hello!"
}
]
}
curl --request POST \
--url https://api.arize.com/v2/prompts/{prompt_id}/versions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_message": "Updated system prompt for better responses",
"input_variable_format": "f_string",
"provider": "open_ai",
"model": "gpt-4",
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": "Hello, {name}!"
}
]
}
'{
"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": "open_ai",
"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"
}Documentation Index
Fetch the complete documentation index at: https://arize-ax.mintlify.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
The unique identifier of the prompt A universally unique identifier
"RW50aXR5OjEyMzQ1"
Body
Body containing prompt version creation parameters
Commit message describing this version
The LLM provider to use
open_ai, azure_open_ai, aws_bedrock, vertex_ai, anthropic, custom The messages that make up the prompt template
1Show child attributes
Show child attributes
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 asf_string. Will be removed in a future version.
f_string, mustache, none The 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).
Show child attributes
Show child attributes
Provider-specific parameters. Optional. Defaults to empty (no provider-specific parameters).
Show child attributes
Show child attributes
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.
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
Show child attributes
Show child attributes
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 asf_string. Will be removed in a future version.
f_string, mustache, none The LLM provider to use
open_ai, azure_open_ai, aws_bedrock, vertex_ai, anthropic, 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
Show child attributes
Show child attributes
Provider-specific parameters
Show child attributes
Show child attributes
Label names currently pointing to this version (e.g., "production", "staging"). Labels are case-sensitive.
Was this page helpful?
Suggestions