Skip to content

DatasetsApi.md

Latest commit

 

History

History
188 lines (105 loc) · 5.43 KB

DatasetsApi.md

File metadata and controls

188 lines (105 loc) · 5.43 KB

\DatasetsApi

All URIs are relative to https://app.hotdata.dev

Method HTTP request Description
create_dataset POST /v1/datasets Create dataset
delete_dataset DELETE /v1/datasets/{id} Delete dataset
get_dataset GET /v1/datasets/{id} Get dataset
list_dataset_versions GET /v1/datasets/{id}/versions List dataset versions
list_datasets GET /v1/datasets List datasets
update_dataset PUT /v1/datasets/{id} Update dataset

create_dataset

models::CreateDatasetResponse create_dataset(create_dataset_request) Create dataset

Create a new dataset from an uploaded file or inline data. The dataset becomes a queryable table under the datasets schema (e.g., SELECT * FROM datasets.my_table). Supports CSV, JSON, and Parquet formats. Optionally specify explicit column types.

Parameters

Name Type Description Required Notes
create_dataset_request CreateDatasetRequest [required]

Return type

models::CreateDatasetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_dataset

delete_dataset(id) Delete dataset

Parameters

Name Type Description Required Notes
id String Dataset ID [required]

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_dataset

models::GetDatasetResponse get_dataset(id) Get dataset

Parameters

Name Type Description Required Notes
id String Dataset ID [required]

Return type

models::GetDatasetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_dataset_versions

models::ListDatasetVersionsResponse list_dataset_versions(id, limit, offset) List dataset versions

Parameters

Name Type Description Required Notes
id String Dataset ID [required]
limit Option<i32> Maximum number of versions (default: 100, max: 1000)
offset Option<i32> Pagination offset (default: 0)

Return type

models::ListDatasetVersionsResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_datasets

models::ListDatasetsResponse list_datasets(limit, offset) List datasets

Parameters

Name Type Description Required Notes
limit Option<i32> Maximum number of datasets (default: 100, max: 1000)
offset Option<i32> Pagination offset (default: 0)

Return type

models::ListDatasetsResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_dataset

models::UpdateDatasetResponse update_dataset(id, update_dataset_request) Update dataset

Parameters

Name Type Description Required Notes
id String Dataset ID [required]
update_dataset_request UpdateDatasetRequest [required]

Return type

models::UpdateDatasetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]