Skip to main content
PATCH
/
v2
/
prompts
/
{prompt_id}
Update a prompt
curl --request PATCH \
  --url https://api.arize.com/v2/prompts/{prompt_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated prompt description"
}
'
{
  "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"
}

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

​
prompt_id
string
required

The unique identifier of the prompt A universally unique identifier

Body

application/json

Body containing prompt update parameters. At least one field must be provided.

​
description
string | null

Updated description for the prompt

Response

A prompt object

A prompt is a reusable template for LLM interactions. Prompts can be versioned and labeled to track changes over time. Use prompts to standardize how you interact with LLMs across your application.

​
id
string
required

The prompt ID

​
name
string
required

The prompt name

​
space_id
string
required

The space ID the prompt belongs to

​
created_at
string<date-time>
required

When the prompt was created

​
updated_at
string<date-time>
required

When the prompt was last updated

​
created_by_user_id
string
required

The user ID of the user who created the prompt

​
description
string | null

The prompt description