curl --request POST \
--url https://api.arize.com/v2/prompts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "U3BhY2U6MTIzOmFiY2Q=",
"name": "My Prompt",
"description": "A helpful assistant prompt",
"version": {
"commit_message": "Initial version",
"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": "prompt_001",
"name": "My Prompt",
"description": "A prompt for customer support",
"space_id": "space_12345",
"created_at": "2024-01-01T12:00:00Z",
"updated_at": "2024-01-02T12:00:00Z",
"created_by_user_id": "user_12345",
"version": {
"id": "pv_001",
"prompt_id": "prompt_001",
"commit_hash": "abc123def456",
"commit_message": "Initial version",
"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": {},
"provider_params": {},
"created_at": "2024-01-01T12:00:00Z",
"created_by_user_id": "user_12345",
"labels": []
}
}Create a new prompt with an initial version.
Payload Requirements
curl --request POST \
--url https://api.arize.com/v2/prompts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"space_id": "U3BhY2U6MTIzOmFiY2Q=",
"name": "My Prompt",
"description": "A helpful assistant prompt",
"version": {
"commit_message": "Initial version",
"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": "prompt_001",
"name": "My Prompt",
"description": "A prompt for customer support",
"space_id": "space_12345",
"created_at": "2024-01-01T12:00:00Z",
"updated_at": "2024-01-02T12:00:00Z",
"created_by_user_id": "user_12345",
"version": {
"id": "pv_001",
"prompt_id": "prompt_001",
"commit_hash": "abc123def456",
"commit_message": "Initial version",
"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": {},
"provider_params": {},
"created_at": "2024-01-01T12:00:00Z",
"created_by_user_id": "user_12345",
"labels": []
}
}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.
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Body containing prompt creation parameters with an initial version
ID of the space to create the prompt in
Name of the prompt (must be unique within the space)
Initial version configuration for a new prompt
Show child attributes
Description of the prompt. Optional. If omitted, the prompt has no description.
A prompt object with a resolved version
A prompt with a resolved version. Returned by Create Prompt and Get Prompt. The version is the initial version on create, or the resolved version (latest, by ID, or by label) on get.
The prompt ID
The prompt name
The space ID the prompt belongs to
When the prompt was created
When the prompt was last updated
The user ID of the user who created the prompt
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.
Show child attributes
The prompt description
Was this page helpful?
Suggestions