Skip to content
SupportLogin

Combine

Combine multiple Datasets into a single new merged Dataset
datasets.combine.create(CombineCreateParams**kwargs) -> CombineCreateResponse
POST/api/v1/datasets/combine
Validate that a set of Datasets can be combined
datasets.combine.validate(CombineValidateParams**kwargs)
POST/api/v1/datasets/combine/validate
ModelsExpand Collapse
One of the following:
class CombineResponseDto:
dataset_id: str

The newly created merged Dataset’s ID. Returns existing ID on idempotent replay.

class CombineJobResponseDto:
combine_job_id: str

Background combine job ID. Poll the combine job status endpoint until it succeeds or fails.

status: Literal["queued", "running", "succeeded", "failed"]

Current background combine job status.

One of the following:
"queued"
"running"
"succeeded"
"failed"
dataset_id: Optional[object]

The merged Dataset ID. Null until the background combine succeeds.

error_message: Optional[object]

Customer-safe failure message when the background combine fails.

CombineJobs

Get the status of a background dataset combine job
datasets.combine.jobs.get(strcombine_job_id) -> JobGetResponse
GET/api/v1/datasets/combine/jobs/{combine_job_id}
ModelsExpand Collapse
class JobGetResponse:
combine_job_id: str

Background combine job ID. Poll the combine job status endpoint until it succeeds or fails.

status: Literal["queued", "running", "succeeded", "failed"]

Current background combine job status.

One of the following:
"queued"
"running"
"succeeded"
"failed"
dataset_id: Optional[object]

The merged Dataset ID. Null until the background combine succeeds.

error_message: Optional[object]

Customer-safe failure message when the background combine fails.