Prompts

Update a prompt

Changed on

Update a prompt's metadata by its ID. Currently supports updating the description. The prompt name is immutable after creation; to rename a prompt, delete it and create a new one (note: this loses version history).

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/prompts/{prompt_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/prompts/{prompt_id}
  • Auth
    HTTP bearer

Path parameters

prompt_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique prompt identifier (base64)

Request body

descriptionstring nullable

Updated description for the prompt

Response

A prompt object

idstring required

The prompt ID

namestring required

The prompt name

descriptionstring nullable

The prompt description

space_idstring required

The space ID the prompt belongs to

created_atstring date-time required

When the prompt was created

updated_atstring date-time required

When the prompt was last updated

created_by_user_idstring required

The user ID of the user who created the prompt

Changes

  • 4f94eb2fd1abRevision changes
    • info

      api operation id prompts_update removed and replaced with update_prompt

    • info

      added the non-success response with the status