Datasets
REST API methods for interacting with Phoenix datasets
Cursor for pagination
An optional dataset name to filter by
The max number of datasets to return at a time.
10
GET /v1/datasets HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"id": "text",
"name": "text",
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created_at": "2025-07-20T17:13:41.056Z",
"updated_at": "2025-07-20T17:13:41.056Z"
}
],
"next_cursor": "text"
}
The ID of the dataset
GET /v1/datasets/{id} HTTP/1.1
Host:
Accept: */*
{
"data": {
"id": "text",
"name": "text",
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created_at": "2025-07-20T17:13:41.056Z",
"updated_at": "2025-07-20T17:13:41.056Z",
"example_count": 1
}
}
The ID of the dataset
Cursor for pagination
The max number of dataset versions to return at a time
10
GET /v1/datasets/{id}/versions HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"version_id": "text",
"description": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created_at": "2025-07-20T17:13:41.056Z"
}
],
"next_cursor": "text"
}
If true, fulfill request synchronously and return JSON containing dataset_id.
false
POST /v1/datasets/upload HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"action": "create",
"name": "text",
"description": "text",
"inputs": [
{}
],
"outputs": [
{}
],
"metadata": [
{}
]
}
{
"data": {
"dataset_id": "text",
"version_id": "text"
}
}
The ID of the dataset
The ID of the dataset version (if omitted, returns data from the latest version)
GET /v1/datasets/{id}/examples HTTP/1.1
Host:
Accept: */*
{
"data": {
"dataset_id": "text",
"version_id": "text",
"examples": [
{
"id": "text",
"input": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"output": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"updated_at": "2025-07-20T17:13:41.056Z"
}
]
}
}
The ID of the dataset
The ID of the dataset version (if omitted, returns data from the latest version)
GET /v1/datasets/{id}/csv HTTP/1.1
Host:
Accept: */*
text
The ID of the dataset
The ID of the dataset version (if omitted, returns data from the latest version)
GET /v1/datasets/{id}/jsonl/openai_ft HTTP/1.1
Host:
Accept: */*
text
The ID of the dataset
The ID of the dataset version (if omitted, returns data from the latest version)
GET /v1/datasets/{id}/jsonl/openai_evals HTTP/1.1
Host:
Accept: */*
text
Last updated
Was this helpful?