Skip to main content
POST
Search dataset examples

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

dataset_id
string
required

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

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing optional search criteria for dataset examples

Optional criteria for searching a dataset's examples. Omit all fields to return the first page of examples in ascending order of created_at, with id as a tiebreaker. Keep the filter unchanged when using a returned cursor to fetch the next page.

Filters use the same SQL-like language as span search. Supported column families include unprefixed example columns, id, and annotation.<name>.* when present in the example schema. A present empty or whitespace-only filter is invalid.

filter
string

SQL-like filter expression. Omit to search all examples; an empty or whitespace-only value is invalid.

Example:

"topic = 'arithmetic'"

limit
integer<int32>

Maximum number of examples to return. Defaults to 50 and must be between 1 and 500.

Required range: 1 <= x <= 500
Example:

50

cursor
string

Opaque cursor from pagination.next_cursor. Omit to start at the first page; keep the filter unchanged while paging.

Example:

"opaque-cursor"

dataset_version_id
string

Unique identifier of the dataset version to search. If omitted, the latest version is selected.

Example:

"RGF0YXNldFZlcnNpb246MTIzNDU="

Response

Returns a list of dataset examples as structured objects

examples
object[]
required

Array of example objects from the dataset

pagination
object
required

Pagination metadata for cursor-based navigation