Skip to main content
GET
/
api
/
public
/
v2
/
datasets
List Datasets
curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/datasets \
  --header 'X-API-KEY: <x-api-key>'
{
  "success": true,
  "message": "<string>",
  "datasets": [
    {
      "id": 123,
      "dataset_group_id": 123,
      "version_number": 123,
      "column_names": [
        "<string>"
      ],
      "is_deleted": true,
      "user_id": 123,
      "filter_params": {},
      "dataset_group": {
        "id": 123,
        "name": "<string>",
        "workspace_id": 123,
        "is_deleted": true
      }
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "pages": 123
}
Retrieve a paginated list of datasets based on various filtering criteria. This endpoint allows you to retrieve datasets with various filtering options including dataset group, prompt, report, workspace, and name filters. Supports both JWT and API key authentication.

​
Authentication

This endpoint requires JWT or API key authentication.

​
Filtering by Name

Use the name parameter to search for datasets by their dataset group name. The search is case-insensitive and matches partial names. This is useful for discovering existing datasets programmatically before creating new ones.

​
Filtering by Status

Use the status parameter to control which datasets are returned based on their deletion status:
  • active (default): Returns only active datasets
  • deleted: Returns only deleted/archived datasets
  • all: Returns both active and deleted datasets

Headers

​
X-API-KEY
string
required

API key or JWT token for authentication. Use 'X-API-KEY' header for API key or 'Authorization: Bearer' header for JWT.

Query Parameters

​
dataset_group_id
integer

Filter by specific dataset group ID

Required range: x >= 1
​
prompt_id
integer

Filter by specific prompt ID

Required range: x >= 1
​
prompt_version_id
integer

Filter by specific prompt version ID

Required range: x >= 1
​
prompt_label_id
integer

Filter by specific prompt label ID

Required range: x >= 1
​
workspace_id
integer

Filter by specific workspace ID. If not provided, uses the current user's workspace

Required range: x >= 1
​
report_id
integer

Filter by specific report ID (includes parent report ID)

Required range: x >= 1
​
name
string

Filter datasets by name (case-insensitive partial match on dataset group name)

​
status
enum<string>
default:active

Filter datasets by status: 'active' (default) returns only active datasets, 'deleted' returns only deleted/archived datasets, 'all' returns both

Available options:
active,
deleted,
all
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
per_page
integer
default:10

Number of items per page

Required range: 1 <= x <= 100

Response

Successful response

​
success
boolean
required
​
message
string
required
​
datasets
Dataset · object[]
required
​
page
integer
required
​
per_page
integer
required
​
total
integer
required
​
pages
integer
required