-
GET
/api/v1/user/{user_id}/dataset
List Datasets
Returns the list of Datasets
- Parameters
user_id (string) – User ID
- Query Parameters
skip (integer) – Optional skip for pagination
size (integer) – Optional size for pagination
sort (string) – Optional sort
name (string) – Optional name filter
type (string) – Optional type filter
- Status Codes
200 OK – Returned list of Datasets
-
POST
/api/v1/user/{user_id}/dataset
Create new Dataset
Returns the new Dataset
- Parameters
user_id (string) – User ID
- Status Codes
201 Created – Retuned the new Dataset
400 Bad Request – Bad request, see reply body for details
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}
Retrieve Dataset
Returns the Dataset
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset to return
- Status Codes
200 OK – Returned Dataset
404 Not Found – User or Dataset not found
-
DELETE
/api/v1/user/{user_id}/dataset/{dataset_id}
Delete Dataset
Cancels all related running jobs and returns the deleted Dataset
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset to delete
- Status Codes
200 OK – Deleted Dataset
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Dataset not found
-
PUT
/api/v1/user/{user_id}/dataset/{dataset_id}
Update Dataset
Returns the updated Dataset
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset to update
- Status Codes
200 OK – Returned the updated Dataset
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Dataset not found
-
PATCH
/api/v1/user/{user_id}/dataset/{dataset_id}
Partial update Dataset
Returns the updated Dataset
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset to update
- Status Codes
200 OK – Returned the updated Dataset
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Dataset not found
-
POST
/api/v1/user/{user_id}/dataset/{dataset_id}/upload
Upload Dataset
Upload training and testing data
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
- Status Codes
201 Created – Upload sucessful
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Dataset not found
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}/specs/{action}/schema
Retrieve Specs schema
Returns the Specs schema for a given action
- Parameters
user_id (string) – User ID
dataset_id (string) – ID for Dataset
action (string) – Action name
- Status Codes
200 OK – Returned the Specs schema for given action
404 Not Found – User, Dataset or Action not found
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}/specs/{action}
Retrieve Dataset Specs
Returns the saved Dataset Specs for a given action
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
action (string) – Action name
- Status Codes
200 OK – Returned the saved Dataset Specs for specified action
404 Not Found – User, Dataset or Action not found
-
POST
/api/v1/user/{user_id}/dataset/{dataset_id}/specs/{action}
Save Dataset Specs
Save the Dataset Specs for a given action
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
action (string) – Action name
- Status Codes
201 Created – Returned the saved Dataset Specs for specified action
404 Not Found – User, Dataset or Action not found
-
PUT
/api/v1/user/{user_id}/dataset/{datset_id}/specs/{action}
Update Dataset Specs
Update the Dataset Specs for a given action (same as Save/POST)
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
action (string) – Action name
- Status Codes
200 OK – Returned the updated Dataset Specs for specified action
404 Not Found – User, Dataset or Action not found
-
POST
/api/v1/user/{user_id}/dataset/{dataset_id}/job
Run Dataset Jobs
Asynchronously starts a list of Dataset Actions and returns corresponding Job IDs
- Parameters
user_id (string) – User ID
dataset_id (string) – ID for Dataset
- Status Codes
201 Created – Returned the list of Job IDs corresponding to requested Dataset Actions
404 Not Found – User or Dataset not found
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}/job
List Jobs for Dataset
Returns the list of Jobs
- Parameters
user_id (string) – User ID
dataset_id (string) – ID for Dataset
- Query Parameters
skip (integer) – Optional skip for pagination
size (integer) – Optional size for pagination
sort (string) – Optional sort
- Status Codes
200 OK – Returned list of Jobs
404 Not Found – User or Dataset not found
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}/job/{job_id}
Retrieve Job for Dataset
Returns the Job
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
job_id (string) – Job ID
- Status Codes
200 OK – Returned Job
404 Not Found – User, Dataset or Job not found
-
DELETE
/api/v1/user/{user_id}/dataset/{dataset_id}/job/{job_id}
Delete Dataset Job
delete Dataset Job
- Parameters
user_id (string) – User ID
dataset_id (string) – ID for Dataset
job_id (string) – ID for Job
- Status Codes
200 OK – Successfully requested deletion of specified Job ID
400 Bad Request – Bad request, see reply body for details
404 Not Found – User, Dataset or Job not found
-
POST
/api/v1/user/{user_id}/dataset/{dataset_id}/job/{job_id}/cancel
Cancel Dataset Job
Cancel Dataset Job
- Parameters
user_id (string) – User ID
dataset_id (string) – ID for Dataset
job_id (string) – ID for Job
- Status Codes
200 OK – Successfully requested cancelation of specified Job ID (asynchronous)
404 Not Found – User, Dataset or Job not found
-
GET
/api/v1/user/{user_id}/dataset/{dataset_id}/job/{job_id}/download
Download Job Artifacts
Download the Artifacts produced by a given job
- Parameters
user_id (string) – User ID
dataset_id (string) – ID of Dataset
job_id (string) – Job ID
- Status Codes
200 OK – Returned Job Artifacts
404 Not Found – User, Model or Job not found
-
GET
/api/v1/user/{user_id}/model
List Models
Returns the list of Models
- Parameters
user_id (string) – User ID
- Query Parameters
skip (integer) – Optional skip for pagination
size (integer) – Optional size for pagination
sort (string) – Optional sort
name (string) – Optional name filter
arch (string) – Optional network architecture filter
read_only (boolean) – Optional read_only filter
- Status Codes
200 OK – Returned the list of Models
-
POST
/api/v1/user/{user_id}/model
Create new Model
Returns the new Model
- Parameters
user_id (string) – User ID
- Status Codes
201 Created – Returned the new Model
400 Bad Request – Bad request, see reply body for details
-
GET
/api/v1/user/{user_id}/model/{model_id}
Retrieve Model
Returns the Model
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model to return
- Status Codes
200 OK – Returned the Model
404 Not Found – User or Model not found
-
DELETE
/api/v1/user/{user_id}/model/{model_id}
Delete Model
Cancels all related running jobs and returns the deleted Model
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model to delete
- Status Codes
200 OK – Returned the deleted Model
404 Not Found – User or Model not found
-
PUT
/api/v1/user/{user_id}/model/{model_id}
Update Model
Returns the updated Model
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model to update
- Status Codes
200 OK – Returned the updated Model
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Model not found
-
PATCH
/api/v1/user/{user_id}/model/{model_id}
Partial update Model
Returns the updated Model
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model to update
- Status Codes
200 OK – Returned the updated Model
400 Bad Request – Bad request, see reply body for details
404 Not Found – User or Model not found
-
GET
/api/v1/user/{user_id}/model/{model_id}/specs/{action}/schema
Retrieve Specs schema
Returns the Specs schema for a given action
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
action (string) – Action name
- Status Codes
200 OK – Returned the Specs schema for given action
404 Not Found – Dataset or Action not found
-
GET
/api/v1/user/{user_id}/model/{model_id}/specs/{action}
Retrieve Model Specs
Returns the Model Specs for a given action
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model
action (string) – Action name
- Status Codes
200 OK – Returned the Model Specs for specified action
404 Not Found – User, Model or Action not found
-
POST
/api/v1/user/{user_id}/model/{model_id}/specs/{action}
Save Model Specs
Save the Model Specs for a given action
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model
action (string) – Action name
- Status Codes
201 Created – Returned the saved Model Specs for specified action
404 Not Found – User, Model or Action not found
-
PUT
/api/v1/user/{user_id}/model/{model_id}/specs/{action}
Update Model Specs
Update the Model Specs for a given action (same as Save/POST)
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model
action (string) – Action name
- Status Codes
200 OK – Returned the updated Model Specs for specified action
404 Not Found – User, Model or Action not found
-
POST
/api/v1/user/{user_id}/model/{model_id}/job
Run Model Jobs
Asynchronously starts a list of Model Actions and returns corresponding Job IDs
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
- Status Codes
201 Created – Returned the list of Job IDs corresponding to requested Model Actions
404 Not Found – User or Model not found
-
GET
/api/v1/user/{user_id}/model/{model_id}/job
List Jobs for Model
Returns the list of Jobs
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
- Query Parameters
skip (integer) – Optional skip for pagination
size (integer) – Optional size for pagination
sort (string) – Optional sort
- Status Codes
200 OK – Returned list of Jobs
404 Not Found – User or Model not found
-
GET
/api/v1/user/{user_id}/model/{model_id}/job/{job_id}
Retrieve Job for Model
Returns the Job
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model
job_id (string) – Job ID
- Status Codes
200 OK – Returned Job
404 Not Found – User, Model or Job not found
-
DELETE
/api/v1/user/{user_id}/model/{model_id}/job/{job_id}
Delete Model Job
Delete Model Job
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
job_id (string) – ID for Job
- Status Codes
200 OK – Successfully requested deletion of specified Job ID
400 Bad Request – Bad request, see reply body for details
404 Not Found – User, Model or Job not found
-
POST
/api/v1/user/{user_id}/model/{model_id}/job/{job_id}/cancel
Cancel Model Job (or pause training)
Cancel Model Job (or pause training)
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
job_id (string) – ID for Job
- Status Codes
200 OK – Successfully requested cancelation or training pause of specified Job ID (asynchronous)
404 Not Found – User, Model or Job not found
-
POST
/api/v1/user/{user_id}/model/{model_id}/job/{job_id}/resume
Resume Model Job
Resume Model Job (train/retrain only)
- Parameters
user_id (string) – User ID
model_id (string) – ID for Model
job_id (string) – ID for Job
- Status Codes
200 OK – Successfully requested resume of specified Job ID (asynchronous)
404 Not Found – User, Model or Job not found
-
GET
/api/v1/user/{user_id}/model/{model_id}/job/{job_id}/download
Download Job Artifacts
Download the Artifacts produced by a given job
- Parameters
user_id (string) – User ID
model_id (string) – ID of Model
job_id (string) – Job ID
- Status Codes
200 OK – Returned Job Artifacts
404 Not Found – User, Model or Job not found