> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List dataset examples
> List examples for a given dataset and version.
If version is not passed, the latest version is selected. Examples are
returned in ascending order of `created_at`, with `id` as a tiebreaker.
This order is stable across pages, so cursor pagination never skips or
repeats an example.
**Human annotations**: returned in the structured `annotations` array on
each example. Each entry includes `name`, optional `label` / `score` /
`text` / `updated_at`, and an `annotator` (id + email) for per-user
annotations.
**Pagination**:
- Response includes `pagination` with `has_more` and `next_cursor`.
- Use cursor-based pagination by passing the returned `next_cursor`
value as the `cursor` query parameter in subsequent requests.
This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml get /v2/datasets/{dataset_id}/examples
openapi: 3.0.3
info:
title: Arize REST API
version: 2.0.0
description: |
API specification for the backend data server. The API is hosted globally
at https://api.arize.com/v2 or in your own environment.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: Global
url: https://api.arize.com
- description: Regional
url: https://api.{region}.arize.com
variables:
region:
default: eu-west-1a
enum:
- eu-west-1a
- ca-central-1a
- description: Custom Host
url: https://{host}
variables:
host:
default: api.arize.com
security:
- bearerAuth: []
tags:
- name: AI Integrations
description: |
AI integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
entire account, a specific organization, or a specific space.
- name: Annotation Configs
description: >
Annotation configs allow you to define consistent annotation schemas that
can be reused across your workspace, ensuring evaluations are structured
and
comparable over time.
- name: Annotation Queues
description: >
Annotation queues help you organize and manage human evaluation workflows.
Use queues to assign spans or examples to annotators for review and
labeling.
- name: API Keys
description: >
API keys are used to authenticate requests to the Arize API. List your
keys
to view metadata; the raw secret is never returned after creation.
- name: Datasets
description: |
Datasets are structured, version-controlled example collections you use to
run, evaluate, and track LLM experiments.
- name: Evaluators
description: >
Evaluators are reusable evaluation configurations used to assess the
quality
of LLM outputs. They can be template-based (using LLM judges) or
code-based.
- name: Experiments
description: >
Experiments let you systematically test prompt/model changes using
datasets,
tasks, and evaluators.
- name: Integrations
description: >
Integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
PagerDuty, Slack), and
your own agents. Integrations can be scoped to the entire account, a
specific
organization, or a specific space.
- name: Organizations
description: >
Organizations are top-level containers within an Arize AX account for
grouping spaces.
- name: Projects
description: |
Projects represent LLM applications being monitored in Arize where you can
observe traces and spans.
- name: Prompts
description: >
Prompts are reusable, versioned templates for LLM interactions. Use
prompts
to standardize and manage how you interact with LLMs across your
application.
- name: Resource Restrictions
description: |
Endpoints for restricting and unrestricting resources (projects, models).
- name: Role Bindings
description: |
Role bindings assign a role to a user on a resource. REST currently
supports space- and project-scoped bindings.
- name: Roles
description: >
Roles define sets of permissions that can be assigned to users within an
account. Create custom roles to tailor access control to your team's
needs.
- name: Spaces
description: >
Spaces are containers within an organization for grouping related
projects,
datasets, and experiments, enabling collaboration or isolated
experimentation
with role-based access control.
- name: Spans
description: |
Spans represent individual operations within a trace. A span captures the
timing, status, and attributes of a single operation in your application.
- name: Tasks
description: |
Tasks are configurable units of work that tie one or more evaluators to a
data source (project or dataset). Use tasks to automate evaluation of LLM
outputs, with support for continuous evaluation and backfill runs.
- name: Users
description: >
Users represent members of an account. The Users endpoints allow creating,
listing, updating (display name), and removing users from the account
programmatically.
paths:
/v2/datasets/{dataset_id}/examples:
get:
tags:
- Datasets
summary: List dataset examples
description: >
List examples for a given dataset and version.
If version is not passed, the latest version is selected. Examples are
returned in ascending order of `created_at`, with `id` as a tiebreaker.
This order is stable across pages, so cursor pagination never skips or
repeats an example.
**Human annotations**: returned in the structured `annotations` array on
each example. Each entry includes `name`, optional `label` / `score` /
`text` / `updated_at`, and an `annotator` (id + email) for per-user
annotations.
**Pagination**:
- Response includes `pagination` with `has_more` and `next_cursor`.
- Use cursor-based pagination by passing the returned `next_cursor`
value as the `cursor` query parameter in subsequent requests.
This endpoint is in beta, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: datasets_examples_list
parameters:
- $ref: '#/components/parameters/DatasetIdPathParam'
- $ref: '#/components/parameters/DatasetVersionIdQueryParam'
- $ref: '#/components/parameters/LimitQueryParamMax500'
- $ref: '#/components/parameters/CursorQueryParam'
responses:
'200':
$ref: '#/components/responses/DatasetExampleList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
DatasetIdPathParam:
name: dataset_id
in: path
description: The unique dataset identifier (base64)
required: true
schema:
$ref: '#/components/schemas/Id'
example: RGF0YXNldDoxMjM0NQ==
DatasetVersionIdQueryParam:
name: dataset_version_id
in: query
description: The unique identifier of the dataset version
schema:
$ref: '#/components/schemas/Id'
example: RGF0YXNldFZlcnNpb246MTIzNDU=
LimitQueryParamMax500:
name: limit
in: query
description: Maximum items to return
schema:
type: integer
minimum: 1
maximum: 500
default: 50
CursorQueryParam:
name: cursor
in: query
description: |
Opaque pagination cursor returned from a previous response
(`pagination.next_cursor`). Treat it as an unreadable token; do not
attempt to parse or construct it.
schema:
type: string
responses:
DatasetExampleList:
description: Returns a list of dataset examples as structured objects
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetExampleListResponse'
example:
examples:
- id: 550e8400-e29b-41d4-a716-446655440000
created_at: '2024-01-01T12:00:00Z'
updated_at: '2024-01-02T12:00:00Z'
question: What is 2 + 2?
answer: 4
topic: arithmetic
isCorrect: true
- id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8
created_at: '2024-01-02T12:00:00Z'
updated_at: '2024-01-03T12:00:00Z'
question: What is the square root of 16?
answer: 4
topic: geometry
isCorrect: true
- id: 9c7f6b2e-4a3d-11e9-8bad-f5b7b8c1ae7e
created_at: '2024-01-03T12:00:00Z'
updated_at: '2024-01-04T12:00:00Z'
question: If 3x = 12, what is x?
answer: 3
topic: algebra
isCorrect: false
pagination:
next_cursor: cursor_12345
has_more: true
BadRequest:
description: Invalid request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 400
title: Invalid request parameters
detail: The 'name' field is required and must be a non-empty string.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
Unauthorized:
description: Authentication is required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 401
title: Authentication required
detail: You must be authenticated to access this resource.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#authentication-required
Forbidden:
description: Insufficient permissions to access this resource
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 403
title: Access forbidden
detail: You do not have permission to access this resource.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
NotFound:
description: Not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 404
title: Resource not found
detail: The requested resource with ID '12345' was not found.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
RateLimitExceeded:
description: Rate limit exceeded
headers:
Retry-After:
description: |
When throttled (429), how long to wait before retrying. Value is
either a delta-seconds integer.
schema:
type: integer
minimum: 0
example: 42
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 429
title: Rate limit exceeded
detail: >-
You have exceeded the allowed number of requests. Please try again
later.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
schemas:
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
DatasetExampleListResponse:
type: object
required:
- examples
- pagination
properties:
examples:
type: array
items:
$ref: '#/components/schemas/DatasetExample'
description: Array of example objects from the dataset
pagination:
$ref: '#/components/schemas/PaginationMetadata'
description: Pagination metadata for cursor-based navigation
additionalProperties: false
Problem:
type: object
description: RFC 9457 Problem Details
properties:
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem
type:
type: string
format: uri-reference
description: A URI reference that identifies the problem type
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
instance:
type: string
format: uri-reference
description: >-
A URI reference that identifies the specific occurrence of the
problem
required:
- title
- status
additionalProperties: false
DatasetExample:
type: object
description: |
A dataset example with arbitrary user-defined fields. System-managed
fields are included as read-only for responses.
properties:
id:
type: string
description: System-assigned unique ID for the example
readOnly: true
created_at:
type: string
format: date-time
description: Timestamp for when the example was created
readOnly: true
updated_at:
type: string
format: date-time
description: Timestamp for the last update of the example
readOnly: true
annotations:
type: array
items:
$ref: '#/components/schemas/Annotation'
description: List of human annotations on this dataset example
readOnly: true
required:
- id
- created_at
- updated_at
additionalProperties: true
PaginationMetadata:
required:
- has_more
type: object
properties:
next_cursor:
type: string
description: >
Opaque cursor for fetching the next page. Treat as an unreadable
token.
Present when `has_more` is true; omitted when `has_more` is false.
has_more:
type: boolean
description: True if another page of results is available.
description: |
Cursor-based pagination metadata. Use `next_cursor` in the subsequent
request's `cursor` query parameter.
additionalProperties: false
Annotation:
type: object
description: A human annotation on a record.
required:
- name
properties:
name:
type: string
description: The name of the annotation
score:
type: number
format: double
description: Numeric score for the annotation
label:
type: string
description: Categorical label for the annotation
text:
type: string
description: Free-form text note for the annotation
updated_at:
type: string
format: date-time
description: Timestamp when the annotation was last updated
annotator:
allOf:
- $ref: '#/components/schemas/AnnotatorUser'
description: The user who made this annotation
additionalProperties: false
AnnotatorUser:
type: object
description: A user assigned as an annotator, identified by ID and email.
required:
- id
- email
properties:
id:
type: string
description: The unique identifier for the user
email:
$ref: '#/components/schemas/Email'
additionalProperties: false
Email:
type: string
format: email
description: An email address
example: user@example.com
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat:
description: >
Most Arize AI endpoints require authentication. For those endpoints that
require authentication, include your API key in the request header using
the format
``` Authorization: Bearer
```
````