Seqera Labs datasets API

openapi: 3.0.1
info:
  contact:
    email: info@seqera.io
    url: https://seqera.io
  description: Seqera Platform services API
  title: Seqera actions datasets API
  version: 1.181.0
tags:
- description: Pipeline input datasets (samplesheets) in CSV or TSV format
  name: datasets
paths:
  /datasets:
    delete:
      description: Deletes the dataset identified by the given `datasetId`.
      operationId: DeleteDatasets
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteDatasetsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDatasetsResponse'
          description: OK
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDatasetsResponse'
          description: DeleteDatasets 204 response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Delete dataset
      tags:
      - datasets
    get:
      description: Lists all available datasets in a user context. Append `?workspaceId` to list datasets in a workspace context.
      operationId: ListDatasetsV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Pagination max results
        in: query
        name: max
        schema:
          format: int32
          type: integer
      - description: Pagination offset
        in: query
        name: offset
        schema:
          format: int32
          type: integer
      - description: Search query
        in: query
        name: search
        schema:
          type: string
      - description: Sort field supports (`name`, `modified`), defaults to `name`
        in: query
        name: sortBy
        schema:
          type: string
      - description: Sort direction supports (`asc`, `desc`), defaults to `asc`
        in: query
        name: sortDir
        schema:
          type: string
      - description: Visibility option supports (`visible`, `hidden`, `all`), defaults to `visible`
        in: query
        name: visibility
        schema:
          type: string
      - description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.'
        explode: false
        in: query
        name: attributes
        schema:
          items:
            $ref: '#/components/schemas/DatasetQueryAttribute'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: List datasets
      tags:
      - datasets
    post:
      description: Creates a new dataset in the user context. Include the dataset file and details in your request body. Append `?workspaceId` to create the dataset in a workspace context.
      operationId: CreateDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
        description: Dataset create request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Duplicate element
      security:
      - BearerAuth: []
      summary: Create dataset
      tags:
      - datasets
  /datasets/hide:
    post:
      description: Hide the given `datasetIds`
      operationId: HideDatasets
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDatasetVisibilityRequest'
        description: Dataset ids to be hidden.
        required: true
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Hide dataset
      tags:
      - datasets
  /datasets/preview-url:
    post:
      description: Fetches a partial content preview from an arbitrary HTTP/HTTPS URL, without creating a dataset. Intended for the dataset form preview after URL validation.
      operationId: PreviewDatasetUrl
      parameters:
      - explode: false
        in: query
        name: workspaceId
        schema:
          format: int64
          nullable: true
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUrlRequest'
        description: URL preview request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetPreviewResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Preview content from a URL
      tags:
      - datasets
  /datasets/show:
    post:
      description: Show the given `datasetIds`
      operationId: ShowDatasets
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDatasetVisibilityRequest'
        description: Dataset ids to be shown.
        required: true
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Show dataset
      tags:
      - datasets
  /datasets/validate-url:
    post:
      description: Validates that a remote dataset URL is accessible and returns a supported CSV/TSV format, without creating a dataset.
      operationId: ValidateDatasetUrl
      parameters:
      - explode: false
        in: query
        name: workspaceId
        schema:
          format: int64
          nullable: true
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUrlRequest'
        description: URL validation request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateUrlResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Validate URL for dataset linking
      tags:
      - datasets
  /datasets/versions:
    get:
      description: Lists the latest version of each dataset in the user context. Append `?workspaceId` to list latest versions in a workspace context.
      operationId: ListLatestDatasetVersionsV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset MIME type
        in: query
        name: mimeType
        schema:
          type: string
      - description: Pagination max results
        in: query
        name: max
        schema:
          format: int32
          type: integer
      - description: Pagination offset
        in: query
        name: offset
        schema:
          format: int32
          type: integer
      - description: Search query
        in: query
        name: search
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetVersionsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: List latest dataset versions
      tags:
      - datasets
  /datasets/{datasetId}:
    delete:
      description: Deletes the dataset identified by the given `datasetId`.
      operationId: DeleteDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Delete dataset
      tags:
      - datasets
    put:
      description: Updates the details of the dataset identified by the given `datasetId`.
      operationId: UpdateDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetRequest'
        description: Dataset update request
        required: true
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Duplicate element
      security:
      - BearerAuth: []
      summary: Update dataset
      tags:
      - datasets
  /datasets/{datasetId}/link:
    post:
      description: Creates a new linked DatasetVersion for an existing LINKED dataset by supplying a public HTTP/HTTPS URL.
      operationId: LinkDatasetVersion
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkVersionRequest'
        description: Link version request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadDatasetVersionResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '404':
          description: Dataset not found
      security:
      - BearerAuth: []
      summary: Link external URL as dataset version
      tags:
      - datasets
  /datasets/{datasetId}/metadata:
    get:
      description: Retrieves the metadata of the dataset identified by the given `datasetId`.
      operationId: DescribeDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.'
        explode: false
        in: query
        name: attributes
        schema:
          items:
            $ref: '#/components/schemas/DatasetQueryAttribute'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Describe dataset
      tags:
      - datasets
  /datasets/{datasetId}/upload:
    post:
      description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`.
      operationId: UploadDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: Uploaded file has header
        in: query
        name: header
        schema:
          type: boolean
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MultiRequestFileSchema'
        description: Dataset file request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadDatasetVersionResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Upload new dataset version
      tags:
      - datasets
  /datasets/{datasetId}/v/{version}/n/{fileName}:
    get:
      description: Downloads the content of the dataset identified by the given `datasetId` and `version`.
      operationId: DownloadDatasetV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: Version number to download
        in: path
        name: version
        required: true
        schema:
          type: string
      - description: File name for the downloaded dataset content
        in: path
        name: fileName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                format: binary
                type: string
          description: OK
        '307':
          description: Temporary redirect to linked source URL
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not found
      security:
      - BearerAuth: []
      summary: Download dataset content
      tags:
      - datasets
  /datasets/{datasetId}/v/{version}/preview:
    get:
      description: Fetches a partial preview of the content for a linked dataset version.
      operationId: PreviewDatasetVersion
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: Dataset version number
        in: path
        name: version
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetPreviewResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Dataset or version not found
      security:
      - BearerAuth: []
      summary: Preview linked dataset content
      tags:
      - datasets
  /datasets/{datasetId}/versions:
    get:
      description: Lists all versions of the given `datasetId`.
      operationId: ListDatasetVersionsV2
      parameters:
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: Optional MIME type filter
        in: query
        name: mimeType
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetVersionsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: List all dataset versions
      tags:
      - datasets
  /datasets/{datasetId}/versions/{version}/disable:
    post:
      description: Disable a dataset version, the dataset version cannot be used for runs, and cannot be enabled again
      operationId: DisableDatasetVersion
      parameters:
      - description: The dataset string id the version belongs to
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: The version number to disable
        in: path
        name: version
        required: true
        schema:
          format: int64
          type: integer
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not found
      security:
      - BearerAuth: []
      summary: Disable a dataset version
      tags:
      - datasets
  /launch/{launchId}/datasets:
    get:
      description: Retrieves the details of the datasets used in the launch identified by the given `launchId`.
      operationId: ListLaunchDatasetVersions
      parameters:
      - description: Launch string identifier
        in: path
        name: launchId
        required: true
        schema:
          type: string
      - description: Workspace numeric identifier
        in: query
        name: workspaceId
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetVersionsResponse'
          description: OK
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Describe launch datasets
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets:
    get:
      deprecated: true
      description: Lists all available datasets in the workspace context identified by the given `workspaceId`.
      operationId: ListDatasets
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: List available datasets
      tags:
      - datasets
    post:
      deprecated: true
      description: Creates a new dataset in the given workspace context. Include the dataset file and details in your request body.
      operationId: CreateDataset
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetRequest'
        description: Dataset create request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Duplicate element
      security:
      - BearerAuth: []
      summary: Create dataset
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets/versions:
    get:
      deprecated: true
      description: Lists the latest version of each dataset associated with the given `workspaceId`.
      operationId: ListWorkspaceDatasetVersions
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - explode: false
        in: query
        name: mimeType
        schema:
          nullable: true
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetVersionsResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: List latest dataset versions
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets/{datasetId}:
    delete:
      deprecated: true
      description: Deletes the dataset identified by the given `datasetId`.
      operationId: DeleteDataset
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Delete dataset
      tags:
      - datasets
    put:
      deprecated: true
      description: Updates the details of the dataset identified by the given `datasetId`.
      operationId: UpdateDataset
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatasetRequest'
        description: Dataset update request
        required: true
      responses:
        '204':
          description: OK - No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Duplicate element
      security:
      - BearerAuth: []
      summary: Update dataset
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets/{datasetId}/metadata:
    get:
      deprecated: true
      description: Retrieves the metadata of the dataset identified by the given `datasetId`.
      operationId: DescribeDataset
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: 'Additional attribute values to include in the response (`labels`). Returns an empty value (`labels: null`) if omitted.'
        explode: false
        in: query
        name: attributes
        schema:
          items:
            $ref: '#/components/schemas/DatasetQueryAttribute'
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Describe dataset
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets/{datasetId}/upload:
    post:
      deprecated: true
      description: Uploads the CSV or TSV content to create a new version of the dataset identified by the given `datasetId`.
      operationId: UploadDataset
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: Uploaded file has header
        in: query
        name: header
        schema:
          type: boolean
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MultiRequestFileSchema'
        description: Dataset file request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadDatasetVersionResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          description: Operation not allowed
      security:
      - BearerAuth: []
      summary: Upload new dataset version
      tags:
      - datasets
  /workspaces/{workspaceId}/datasets/{datasetId}/versions:
    get:
      deprecated: true
      description: Lists all versions of the given `datasetId`.
      operationId: ListDatasetVersions
      parameters:
      - description: Workspace numeric identifier
        in: path
        name: workspaceId
        required: true
        schema:
          format: int64
          type: integer
      - description: Dataset string identifier
        in: path
        name: datasetId
        required: true
        schema:
          type: string
      - description: MIME type filter
        in: query
        name: mimeType
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetVers

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/seqera-labs/refs/heads/main/openapi/seqera-labs-datasets-api-openapi.yml