Dataset.upload¶
Upload a file from disk to this dataset.
Accepts any file type — CSV, S2P, S1P, PNG, etc. The backend auto-detects the file type and creates appropriate traces.
Signature¶
upload(file_path: str) -> dict[str, Any]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
file_path |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
dataset_id |
path |
string |
yes | - |
create_imagefile |
query |
boolean |
no | false |
Fields¶
| Field | Type | Required |
|---|---|---|
file |
string |
yes |
Return shape¶
HTTP 201 — Created
Schema: DataFileSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
yes |
hash |
string |
yes |
id |
string |
yes |
image_url |
string |
yes |
level_counts |
object |
yes |
name |
string |
yes |
owner_id |
string |
yes |
parquet_column_schema |
object |
yes |
parquet_error |
string |
yes |
parquet_row_count |
integer |
yes |
parquet_status |
string |
yes |
reference_id |
integer |
yes |
source_file_url |
string |
yes |
type |
string |
yes |
updated_at |
string |
yes |
Permission¶
Required permission: dataset:write
HTTP¶
POST /api/datasets/{id}/datafiles/ (uploadDataFile)
Usage¶
ds.upload("data/sweep_25c.s2p")
ds.upload("screenshots/scope_capture.png")