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: <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
      },
      "external_ids": [
        {
          "source": "<string>",
          "external_id": "<string>"
        }
      ]
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptlayer.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Authorizations

X-API-KEY
string
header
required

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
created_by_email
string

Filter by the creator's email address.

created_after
string<date-time>

Filter resources created at or after this timestamp.

created_before
string<date-time>

Filter resources created at or before this timestamp.

updated_after
string<date-time>

Filter resources updated at or after this timestamp.

updated_before
string<date-time>

Filter resources updated at or before this timestamp.

external_source
string

External ID source to filter by. Must be provided with external_id.

external_id
string

External ID value to filter by. Must be provided with external_source.

sort_by
enum<string>

Sort field.

Available options:
created_at,
updated_at,
name,
id
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

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