Prompts

Get a prompt

Changed on

Get a specific prompt by its ID. The response always includes a resolved version. By default, the latest version is returned. Use the version_id or label query parameter to resolve a specific version instead. You cannot supply both version_id and label.

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

get/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)

Query parameters

version_idstring

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

Example:RW50aXR5OjEyMzQ1

Return the prompt with this specific version (base64 identifier (base64)). Mutually exclusive with label.

labelstring

Return the prompt with the version pointed to by this label (e.g., "production"). Mutually exclusive with version_id.

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

  • 4f94eb2fd1abRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id prompts_get removed and replaced with get_prompt

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      removed the non-success response with the status