Skip to content
Adaption Adaption Adaption
SupportGo to app
API Reference

Datasets

Create a dataset from file upload, HuggingFace, or Kaggle
datasets.create(DatasetCreateParams**kwargs) -> DatasetCreateResponse
POST/api/v1/datasets
Get a dataset by ID
datasets.get(strdataset_id) -> Dataset
GET/api/v1/datasets/{dataset_id}
List datasets
datasets.list(DatasetListParams**kwargs) -> SyncCursor[DatasetListResponse]
GET/api/v1/datasets
Get the processing status of a dataset
datasets.get_status(strdataset_id) -> DatasetGetStatusResponse
GET/api/v1/datasets/{dataset_id}/status
Download the processed dataset
datasets.download(strdataset_id, DatasetDownloadParams**kwargs) -> DatasetDownloadResponse
GET/api/v1/datasets/{dataset_id}/download
Publish a dataset to an external platform
datasets.publish(strdataset_id, DatasetPublishParams**kwargs) -> DatasetPublishResponse
POST/api/v1/datasets/{dataset_id}/publish
Start an augmentation run (or estimate cost)
datasets.run(strdataset_id, DatasetRunParams**kwargs) -> DatasetRunResponse
POST/api/v1/datasets/{dataset_id}/run
Get evaluation results for a dataset
datasets.get_evaluation(strdataset_id) -> DatasetGetEvaluationResponse
GET/api/v1/datasets/{dataset_id}/evaluation
ModelsExpand Collapse
class Dataset: …
configured_column_mapping: Optional[ConfiguredColumnMapping]

User-configured column mapping. Null if not yet configured.

chat: Optional[str]
completion: Optional[str]
context: List[str]
prompt: Optional[str]
created_at: datetime

Timestamp when the dataset was created

formatdate-time
dataset_id: str

Unique dataset identifier

error: Optional[Error]

Error details if the dataset failed. Null otherwise.

message: str

Error message

evaluation_summary: Optional[EvaluationSummary]

Compact evaluation summary. Null if evaluation has not completed.

grade_after: Optional[str]

Letter grade (A-E) after augmentation

grade_before: Optional[str]

Letter grade (A-E) before augmentation

improvement_percent: Optional[float]

Relative improvement percentage

score_after: Optional[float]

Quality score after augmentation

score_before: Optional[float]

Quality score before augmentation

name: Optional[str]

Human-readable name for the dataset

progress: Optional[Progress]

Processing progress. Null when no run is active.

percent: Optional[int]

Progress percentage (0-100)

processed_rows: Optional[int]

Number of rows processed so far

total_rows: Optional[int]

Total rows to process (samples_to_process or row_count)

row_count: Optional[int]

Total number of rows in the dataset

run_id: Optional[str]

ID of the currently active run

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

Lifecycle status: pending, running, succeeded, or failed

One of the following:
"pending"
"running"
"succeeded"
"failed"
updated_at: datetime

Timestamp of the last update

formatdate-time

DatasetsUpload

Initiate a dataset upload
datasets.upload.initiate(UploadInitiateParams**kwargs) -> UploadInitiateResponse
POST/api/v1/datasets/upload/initiate
Complete a dataset upload and trigger processing
datasets.upload.complete(UploadCompleteParams**kwargs) -> UploadCompleteResponse
POST/api/v1/datasets/upload/complete
Complete a file upload and trigger processing
datasets.upload.complete_by_id(strdataset_id, UploadCompleteByIDParams**kwargs) -> UploadCompleteByIDResponse
POST/api/v1/datasets/{dataset_id}/upload/complete