Prompts

Create a prompt

Changed on

Create a new prompt with an initial version.

Payload Requirements

  • The prompt name must be unique within the given space.
  • At least one message is required.

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

post/v2/prompts

Request

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

Request body

space_idstring required

ID of the space to create the prompt in

namestring required

Name of the prompt (must be unique within the space)

descriptionstring

Description of the prompt. Optional. If omitted, the prompt has no description.

Response

A prompt object with a resolved version

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

  • 9263b98aaefbRevision changes
    • info

      added the optional property /////// to the response with the status

  • 4d95080d8ffbRevision changes
    • breaking

      added to the // request property allOf list

    • warning

      removed from the // request property allOf list