> ## 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.
# Delete dataset examples
> Delete a collection of examples from a dataset by their IDs.
The delete is partial-tolerant: examples that exist in the selected version
are deleted, and every requested ID that was not deleted is reported back.
A `200 OK` response always includes:
- `completed` — `true` if the operation finished and no retry is needed;
`false` if it could not fully complete (retry the full request).
- `deleted_example_ids` — example IDs confirmed deleted in this request.
- `not_deleted_example_ids` — requested IDs not deleted: either not found in
the selected version (never added, or already deleted), or not completed
when `completed` is `false`.
The delete operation is idempotent — re-submitting already-deleted IDs is safe.
**Payload Requirements**
- `dataset_version_id` is required and identifies the version to delete from.
- `example_ids` must contain at least one ID and at most 1000 IDs.
- `example_ids` must not contain duplicate or empty IDs.
**Valid example**
```json
{
"dataset_version_id": "RGF0YXNldFZlcnNpb246MTIzNDU=",
"example_ids": [
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
}
```
**Invalid example** (missing `dataset_version_id`)
```json
{
"example_ids": ["550e8400-e29b-41d4-a716-446655440000"]
}
```
This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml delete /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:
delete:
tags:
- Datasets
summary: Delete dataset examples
description: >
Delete a collection of examples from a dataset by their IDs.
The delete is partial-tolerant: examples that exist in the selected
version
are deleted, and every requested ID that was not deleted is reported
back.
A `200 OK` response always includes:
- `completed` — `true` if the operation finished and no retry is needed;
`false` if it could not fully complete (retry the full request).
- `deleted_example_ids` — example IDs confirmed deleted in this request.
- `not_deleted_example_ids` — requested IDs not deleted: either not
found in
the selected version (never added, or already deleted), or not completed
when `completed` is `false`.
The delete operation is idempotent — re-submitting already-deleted IDs
is safe.
**Payload Requirements**
- `dataset_version_id` is required and identifies the version to delete
from.
- `example_ids` must contain at least one ID and at most 1000 IDs.
- `example_ids` must not contain duplicate or empty IDs.
**Valid example**
```json
{
"dataset_version_id": "RGF0YXNldFZlcnNpb246MTIzNDU=",
"example_ids": [
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
}
```
**Invalid example** (missing `dataset_version_id`)
```json
{
"example_ids": ["550e8400-e29b-41d4-a716-446655440000"]
}
```
This endpoint is in alpha, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: datasets_examples_delete
parameters:
- $ref: '#/components/parameters/DatasetIdPathParam'
requestBody:
$ref: '#/components/requestBodies/DeleteDatasetExamplesRequestBody'
responses:
'200':
$ref: '#/components/responses/DatasetExamplesDeleteSuccess'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimitExceeded'
'503':
$ref: '#/components/responses/DatasetExamplesDeleteError'
components:
parameters:
DatasetIdPathParam:
name: dataset_id
in: path
description: The unique dataset identifier (base64)
required: true
schema:
$ref: '#/components/schemas/Id'
example: RGF0YXNldDoxMjM0NQ==
requestBodies:
DeleteDatasetExamplesRequestBody:
description: Body containing the IDs of dataset examples to delete
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetExampleDeleteRequest'
example:
dataset_version_id: RGF0YXNldFZlcnNpb246MTIzNDU=
example_ids:
- 550e8400-e29b-41d4-a716-446655440000
- 6ba7b810-9dad-11d1-80b4-00c04fd430c8
responses:
DatasetExamplesDeleteSuccess:
description: >
Dataset examples deleted. The delete is partial-tolerant: existing
examples
are deleted and every requested ID not deleted is reported back.
The response body always includes:
- `completed`: `true` if the operation finished; `false` if it could not
fully
complete (retry the full request).
- `deleted_example_ids`: IDs confirmed deleted.
- `not_deleted_example_ids`: requested IDs not deleted — not found in
the
selected version, or not completed when `completed` is `false`.
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetExampleDeleteResponse'
examples:
full_success:
summary: All requested examples deleted
value:
completed: true
deleted_example_ids:
- 550e8400-e29b-41d4-a716-446655440000
- 6ba7b810-9dad-11d1-80b4-00c04fd430c8
not_deleted_example_ids: []
some_not_found:
summary: Some examples were not found in the selected version
value:
completed: true
deleted_example_ids:
- 550e8400-e29b-41d4-a716-446655440000
not_deleted_example_ids:
- 6ba7b810-9dad-11d1-80b4-00c04fd430c8
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
UnprocessableEntity:
description: Unprocessable entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 422
title: Unprocessable Entity
detail: One or more fields failed validation.
instance: /resource/12345
type: >-
https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
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
DatasetExamplesDeleteError:
description: >
Returned as `503 Service Unavailable` when the request fails after
partially
completing. `deleted_example_ids` lists what was already deleted and
`not_deleted_example_ids` lists what still needs deletion. The caller
should
retry the original full request — the delete operation is idempotent.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/DatasetExampleDeleteProblem'
example:
status: 503
title: Service Unavailable
detail: >-
Result incomplete: inspect deleted_example_ids, then retry the
full request.
type: >-
https://arize.com/docs/ax/rest-reference/errors#service-unavailable
deleted_example_ids:
- 550e8400-e29b-41d4-a716-446655440000
not_deleted_example_ids:
- 6ba7b810-9dad-11d1-80b4-00c04fd430c8
schemas:
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
DatasetExampleDeleteRequest:
type: object
description: Body containing the IDs of dataset examples to delete
required:
- dataset_version_id
- example_ids
properties:
dataset_version_id:
type: string
description: |
Version to delete the examples from. Required. Examples are
removed in place from this version; no new version is created.
example_ids:
type: array
minItems: 1
maxItems: 1000
items:
type: string
description: IDs of the examples to delete. Up to 1000 per request.
additionalProperties: false
DatasetExampleDeleteResponse:
type: object
description: >
Result of a DELETE dataset examples request.
The delete is partial-tolerant: examples that exist in the selected
version
are deleted, and every requested ID that was not deleted is reported in
`not_deleted_example_ids` so the caller can act on it.
A `200 OK` response always includes:
- `completed` — `true` if the operation finished and no retry is needed;
`false` if it could not fully complete (retry the full request).
- `deleted_example_ids` — example IDs confirmed deleted in this request.
- `not_deleted_example_ids` — requested IDs not deleted: either not
found in
the selected version (never added, or already deleted), or whose deletion
did not complete when `completed` is `false`.
required:
- completed
- deleted_example_ids
- not_deleted_example_ids
properties:
completed:
type: boolean
description: >
`true` when the operation finished and no retry is needed. `false`
when
the operation could not fully complete — retry the original full
request
(the delete is idempotent).
deleted_example_ids:
type: array
items:
type: string
description: Example IDs confirmed deleted in this request.
not_deleted_example_ids:
type: array
items:
type: string
description: >
Requested example IDs that were not deleted: either not found in the
selected version (never added, or already deleted), or whose
deletion did
not complete when `completed` is `false`.
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
DatasetExampleDeleteProblem:
description: >
RFC 9457 Problem Details extended with dataset example delete context.
Returned as `503` when the request fails after partially completing, so
the
caller knows which IDs were already deleted and which still need to be
retried.
The delete operation is idempotent — retrying the original full request
is safe.
allOf:
- $ref: '#/components/schemas/Problem'
- type: object
properties:
deleted_example_ids:
type: array
items:
type: string
description: >
Example IDs confirmed deleted before the failure occurred. Safe
to
include or omit on retry, as the delete operation is idempotent.
not_deleted_example_ids:
type: array
items:
type: string
description: >
Requested example IDs that were not deleted before the failure
occurred. Retry the original request to attempt deletion of
these IDs.
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
```
````