Skip to main content

Datasets

Datasets are CSV (comma-separated values) and TSV (tab-separated values) files stored in a workspace. They are used as inputs to pipelines to simplify data management, minimize user data-input errors, and facilitate reproducible workflows.

Path and query parameters

Name

Type

Location

Req/Opt

Description

workspaceId

integer

query

Optional

Workspace numeric identifier. If omitted, lists datasets in a user context.

max

integer

query

Optional

Maximum number of results to return per page.

offset

integer

query

Optional

Number of results to skip for pagination. Default: 0.

search

string

query

Optional

Free-text search filter to match against dataset names and descriptions.

sortBy

string

query

Optional

Field to sort results by. Accepts name, modified, or used. Default: name.

sortDir

string

query

Optional

Sort direction for results. Accepts asc (ascending) or desc (descending). Default: asc.

visibility

string

query

Optional

Dataset visibility filter. Accepts visible, hidden, or all. Default: visible.

attributes

array

query

Optional

Additional attribute values to include in the response. Accepts labels. Returns null for omitted attributes.

mimeType

string

query

Optional

Dataset MIME type filter (e.g., text/csv, text/tab-separated-values).

datasetId

string

path

Required

Dataset string identifier.

header

boolean

query

Optional

Indicates whether the uploaded file contains a header row. Default: true.

version

string

path

Required

Dataset version number.

fileName

string

path

Required

File name for the downloaded dataset content. Must match the original uploaded filename.

launchId

string

path

Required

Launch string identifier.

workspaceId

integer

path

Required

Workspace numeric identifier

Request body parameters

Name

Type

Req/Opt

Description

CreateDatasetV2

Create dataset

name

string

Optional

Name for the new dataset.

description

string

Optional

Optional description of the dataset purpose and contents.

sourceType

string

Optional

Dataset source type. Accepts UPLOADED for uploaded dataset files or LINKED for externally linked dataset URLs.

DeleteDatasets

Delete datasets

datasetIds

array

Optional

Array of dataset string identifiers to delete.

UpdateDatasetV2

Update dataset

name

string

Optional

Updated dataset name.

description

string

Optional

Updated description of the dataset contents and purpose.

CreateDataset

(Deprecated) Create dataset

name

string

Optional

Name for the new dataset.

description

string

Optional

Optional description of the dataset purpose and contents.

sourceType

string

Optional

Dataset source type. Accepts UPLOADED for uploaded dataset files or LINKED for externally linked dataset URLs.

UpdateDataset

(Deprecated) Update dataset

name

string

Optional

Updated dataset name.

description

string

Optional

Updated description of the dataset contents and purpose.

HideDatasets

Hide datasets

datasetIds

array

Optional

Array of dataset string identifiers to show or hide.

ShowDatasets

Show datasets

datasetIds

array

Optional

Array of dataset string identifiers to show or hide.

PreviewDatasetUrl

Preview content from a URL

url

string

Optional

HTTP or HTTPS URL to validate. Maximum length is 2048 characters.

ValidateDatasetUrl

Validate URL for dataset linking

url

string

Optional

HTTP or HTTPS URL to validate. Maximum length is 2048 characters.

LinkDatasetVersion

Link external URL as dataset version

hasHeader

boolean

Optional

When true, treats the first row of the linked CSV or TSV file as a header row. Defaults to true.

url

string

Optional

HTTP or HTTPS URL pointing to a public CSV or TSV file. Maximum length is 2048 characters.