DetaBord REST API Reference – version 1.0

Rest API for the secure data to machine learning interface DetaBord.

Start local server with dq0.io using dq0 server start. The server listens on port 9000 and communicates with dq0-main via current active dq0-proxy instance.

To start your local DetaBord API server, use the dq0.io (command line interface) application:

dq0 server start [--hostname] [--port]

By default, hostname is 127.0.0.1 and port 9000. Resulting default API endpoint would be:

http://127.0.0.1:9000/api/

Response Format

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

# error response will contain only error property
{
"error": "error message"
}

# message response will contain only message property
{
"message": "some message"
}

# single item response will contain only item itself
{
"id": "id1",
"prop": "value",
...
}

# list items response format looks like:
{
"total": 120,
"page": 3,
"page_size": 10,
"items": [
{
"id": "id1",
"prop": "value",
...
}
]
}

The status codes that are returned for each endpoint are specified in the endpoint documentation below.

Base URLs:

actions

ActionPermissionSetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/actions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"action":"UserRegister","action_id":1,"permission":4,"role_id":1,"role_name":"admin"}'

GET /actions

Body parameter

{
  "action": "UserRegister",
  "action_id": 1,
  "permission": 4,
  "role_id": 1,
  "role_name": "admin"
}

Parameters

NameInTypeRequiredDescription
bodybodyActionPermissionSetRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureActionPermissionSetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

artifacts

ArtifactDownloadRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/artifacts/download \
  --header 'Accept: application/json'

GET /artifacts/download

Downloads specific artifact from specific run

Parameters

NameInTypeRequiredDescription
run_uuidquerystringfalseUUID of run (=job uuid)
artifact_pathquerystringfalsePath of artifact to download

Example responses

200 Response

{
  "data_path": "\"out_file.txt\"",
  "data_string": "[]"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureArtifactDownloadResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ArtifactTreeStructureRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/artifacts/tree_structure \
  --header 'Accept: application/json'

GET /artifacts/tree_structure

Returns hierarchical tree structure for specific run

Parameters

NameInTypeRequiredDescription
run_uuidquerystringfalseUUID of run (=job)
pathquerystringfalseOptional path inside artifact directory
levelquerystringfalseLevel of depth to search the artifact directory, default 4

Example responses

200 Response

{
  "artifact_files": [
    {
      "children": [
        {}
      ],
      "file_size": "string",
      "header": "string",
      "is_dir": true,
      "label": "string",
      "path": "string"
    }
  ],
  "artifact_next_page_token": "string",
  "commit_name": "string",
  "commit_uuid": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_name": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_id": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureArtifactTreeStructureResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

audits

AuditListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/audits \
  --header 'Accept: application/json'

GET /audits

Lists all available audit log entries.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page

Example responses

200 Response

{
  "items": [
    {
      "action": "auth.login",
      "actor": "user@dq0.io",
      "description": "user with email 'user@dq0.io' and device '78e1e9d4-cc8c-48da-a325-1c0f908cd9a5' logged in successfully",
      "timestamp": "1587463859"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureAuditListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

auth

authLoginRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /auth/login

Login user in quarantine through current proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

NameInTypeRequiredDescription
bodybodyAuthLoginRequestBodytruenone

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureAuthLoginResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

authLogoutRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/logout \
  --header 'Accept: application/json'

POST /auth/logout

Logout user in quarantine through current proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureAuthLogoutResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

authRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /auth/register

Register user in activated proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

NameInTypeRequiredDescription
bodybodyAuthRegisterRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureAuthRegisterResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

authSessionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/auth/session \
  --header 'Accept: application/json'

GET /auth/session

Get current activated proxy session

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureAuthSessionResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

commits

CommitListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/commits \
  --header 'Accept: application/json'

GET /commits

Lists all available commits.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_name": "string",
      "data_uuid": "string",
      "latest_experiment_name": "string",
      "latest_experiment_result": "string",
      "latest_experiment_uuid": "string",
      "model_checker_status": "string",
      "model_name": "string",
      "model_uuid": "string",
      "predict_allowed": true,
      "predict_proba_allowed": true,
      "project_name": "string",
      "project_uuid": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureCommitListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

CommitInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/commits/ \
  --header 'Accept: application/json'

GET /commits/{commit_uuid}

Get information for specific commit

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureCommitInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

CommitContentRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits/string/content \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"local_only":true,"project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/content

Get information for specific commit

Body parameter

{
  "local_only": true,
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
commit_uuidpathstringtrueUUID of commit
bodybodyCommitContentRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureCommitContentResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

CommitRunRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits/string/run \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"args":{"property1":"string","property2":"string"},"ml_project_entry_point":"train","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/run

Run specific commit with passed user arguments

Body parameter

{
  "args": {
    "property1": "string",
    "property2": "string"
  },
  "ml_project_entry_point": "train",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
commit_uuidpathstringtrueUUID of commit
bodybodyCommitRunRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureCommitRunResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

CommitTransformRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits//transform \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/transform

Start data transform for specific commit

Body parameter

{
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of commit
bodybodyCommitTransformRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureCommitTransformResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

data

DataListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data \
  --header 'Accept: application/json'

GET /data

Lists all available datasets.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project
commit_uuidquerystringfalseUUID of commit

Example responses

200 Response

{
  "items": "'[{\"id\":1,\"uuid\":\"78fbda3a-6530-45ba-83b0-fe2d7dda899d\",\"name\":\"source 1\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\",\"sample\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source1.csv\",\"size\":4,\"mean\":\"(-23.538887188473396, 4.5820969395656865, 10.53646357964901, 7.1721683055053)\",\"std\":\"(8.79595482855613, 15.038949447047374, 15.76694875021541, 55.907788290107405)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-24 08:50:57.175\",\"updated_at\":\"2020-04-06 07:05:05.079\"},{\"id\":2,\"uuid\":\"a87e55d0-aa7c-41c8-9147-1f69b16accc2\",\"name\":\"source 2\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source2.csv\",\"size\":5,\"mean\":\"(-64.64820261903593, 45.56088456347706, 44.27540826516029, 0.8988506631702773, -43.96628296178475)\",\"std\":\"(38.296517680818894, 18.843032606250475, 30.83218542407734, 39.104564678591636, 62.714621754899326)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-24 08:50:57.176\",\"updated_at\":\"2020-04-06 07:05:05.08\"},{\"id\":3,\"uuid\":\"1d3c0ed7-a092-4ce6-b947-55a376dc312b\",\"name\":\"source 3\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source3.csv\",\"size\":5323669,\"mean\":\"(0.2964112953231287, 0.12005084567531446, 0.6048137927357801, 0.014094863934083933, 0.02116986459954208, 0.40440611493306095, 0.029147126455147773, 0.0650217121756085, 0.00026026997636017146, 0.016913810102030358, 0.0019003011109808422, 0.0005982953058642256, 0.23932725135030042)\",\"std\":\"(0.18807155928503272, 0.07656611702507954, 0.1709745075446674, 0.06317847401767661, 0.09497729877421364, 0.12309145556565027, 0.17006894010079007, 0.24460727006477984, 0.009326928792466644, 0.4608292162296523, 0.17959469088151425, 0.26998778640743437, 0.19910365111781858)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-26 08:28:01.871\",\"updated_at\":\"2020-04-06 07:05:05.08\"}]'",
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/data \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"meta":"string"}'

POST /data

Creates new dataset

Body parameter

{
  "meta": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyDataCreateRequestBodytruenone

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json'

DELETE /data/{data_uuid}

Deletes specific data

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json'

GET /data/{data_uuid}

Get information for specific dataset

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataPatchRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"meta":"string"}'

PATCH /data/{data_uuid}

Update a specific dataset

Body parameter

{
  "meta": "string"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of dataset
bodybodyDataPatchRequestBodytruenone

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataPatchResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataPermissionSetRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/data//permissions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"census","data_uuid":"string","permission":4,"role_id":1,"role_name":"admins"}'

POST /data/{data_uuid}/permissions

Set permission for specific dataset

Body parameter

{
  "data_id": 1,
  "data_name": "census",
  "data_uuid": "string",
  "permission": 4,
  "role_id": 1,
  "role_name": "admins"
}

Parameters

NameInTypeRequiredDescription
bodybodyDataPermissionSetRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataPermissionSetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

DataGetSampleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data//sample \
  --header 'Accept: application/json'

GET /data/{data_uuid}/sample

Get sample data for specific dataset

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of dataset

Example responses

200 Response

{
  "name": "census",
  "sample": "[{\"lastname\":\"Lastname282\",\"firstname\":\"Firstname928\",\"age\":24,\"workclass\":\"Private\",\"fnlwgt\":157177,\"education\":\"Masters\",\"education-num\":14,\"marital-status\":\"Married-civ-spouse\",\"occupation\":\"Prof-specialty\",\"relationship\":\"Husband\",\"race\":\"White\",\"sex\":\"Male\",\"capital-gain\":0,\"capital-loss\":0,\"hours-per-week\":50,\"native-country\":\"United-States\",\"income\":\"<=50K\"}]",
  "type": "csv",
  "uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDataSampleResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

device

DeviceVersionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/device/version \
  --header 'Accept: application/json'

GET /device/version

Get version information from current device

Example responses

200 Response

{
  "api_version": "1.2.6",
  "architecture": "amd64",
  "built": "2020-05-28T09:55:02Z",
  "cli_version": "1.1.0",
  "os": "darwin"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureDeviceVersionResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

experiments

ExperimentListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/experiments \
  --header 'Accept: application/json'

GET /experiments

Lists all available experiments.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_name": "string",
      "data_uuid": "string",
      "latest_experiment_name": "string",
      "latest_experiment_result": "string",
      "latest_experiment_uuid": "string",
      "model_checker_status": "string",
      "model_name": "string",
      "model_uuid": "string",
      "predict_allowed": true,
      "predict_proba_allowed": true,
      "project_name": "string",
      "project_uuid": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ExperimentCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/experiments \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

POST /experiments

Creates new experiment

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

NameInTypeRequiredDescription
project_uuidquerystringfalseUUID of project
bodybodyExperimentCreateRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ExperimentDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json'

DELETE /experiments/{experiment_uuid}

Deletes specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ExperimentInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json'

GET /experiments/{experiment_uuid}

Get information for specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ExperimentUpdateRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

PATCH /experiments/{experiment_uuid}

Updates specific experiment

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

NameInTypeRequiredDescription
bodybodyExperimentUpdateRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentUpdateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ExperimentRestoreRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/experiments//restore \
  --header 'Accept: application/json'

POST /experiments/{experiment_uuid}/restore

Return information for specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureExperimentRestoreResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

groups

GroupRemoveRoleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/groups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_id":1,"group_name":"owners","role_id":4,"role_name":"owners"}'

GET /groups

RemoveRoles all available groups

Body parameter

{
  "group_id": 1,
  "group_name": "owners",
  "role_id": 4,
  "role_name": "owners"
}

Parameters

NameInTypeRequiredDescription
bodybodyGroupRemoveRoleRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureGroupRemoveRoleResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

GroupCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/groups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_name":"Admin, User"}'

POST /groups

Creates new Group

Body parameter

{
  "group_name": "Admin, User"
}

Parameters

NameInTypeRequiredDescription
bodybodyGroupCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureGroupCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

GroupDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/groups/string \
  --header 'Accept: application/json'

DELETE /groups/{group_id}

Remove specific group instance from list

Parameters

NameInTypeRequiredDescription
group_idpathstringtrueID of Group

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureGroupDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

GroupGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/groups/string \
  --header 'Accept: application/json'

GET /groups/{group_id}

Get detail information for specific group

Parameters

NameInTypeRequiredDescription
group_idpathstringtrueID of Group

Example responses

200 Response

{
  "created_at": 0,
  "group_id": 0,
  "group_name": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureGroupGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

GroupPatchRequest

Code samples

curl --request PATCH \
  --url 'http://localhost:9000/api/groups/0?group_id=0' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_name":"MyGroup"}'

PATCH /groups/{group_id}

Update a specific group

Body parameter

{
  "group_name": "MyGroup"
}

Parameters

NameInTypeRequiredDescription
group_idqueryinteger(int64)trueID of Group
bodybodyGroupPatchRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "group_id": 0,
  "group_name": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureGroupPatchResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

jobs

JobListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/jobs \
  --header 'Accept: application/json'

GET /jobs

Lists all available jobs.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project
commit_uuidquerystringfalseUUID of commit
job_typequerystringfalseType of job
job_paramsquerystringfalseParams of job

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureJobListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

JobInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/jobs/ \
  --header 'Accept: application/json'

GET /jobs/{job_uuid}

Get information for specific job

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureJobInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

JobCancelRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/jobs/string/cancel \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"force":false,"job_uuid":"79ef8712-f3ed-4494-bb34-aa44fe0f000a"}'

POST /jobs/{job_uuid}/cancel

Cancel a running job

Body parameter

{
  "force": false,
  "job_uuid": "79ef8712-f3ed-4494-bb34-aa44fe0f000a"
}

Parameters

NameInTypeRequiredDescription
job_uuidpathstringtrueUUID of job
bodybodyJobCancelRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureJobCancelResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

models

ModelListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/models \
  --header 'Accept: application/json'

GET /models

Lists all available models.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project
commit_uuidquerystringfalseUUID of commit

Example responses

200 Response

{
  "items": [
    {
      "commit_name": "string",
      "commit_uuid": "string",
      "description": "string",
      "experiment_name": "string",
      "experiment_uuid": "string",
      "location": "string",
      "model_name": "string",
      "model_uuid": "string",
      "permissions": [
        "string"
      ],
      "project_name": "string",
      "project_uuid": "string",
      "user_id": 0,
      "user_name": "string"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/models/ \
  --header 'Accept: application/json'

GET /models/{model_uuid}

Get detail information for specific model

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelPatchRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/models/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_description":"\"Model with trained stuff that is crazy\"","model_name":"\"myModel123\"","permissions":"['\''predict_allowed'\'', '\''predict_proba_allowed'\'']"}'

PATCH /models/{model_uuid}

Update a specific model

Body parameter

{
  "model_description": "\"Model with trained stuff that is crazy\"",
  "model_name": "\"myModel123\"",
  "permissions": "['predict_allowed', 'predict_proba_allowed']"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of model
bodybodyModelPatchRequestBodytruenone

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelPatchResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelContentRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/string/content \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST /models/{model_uuid}/content

Get information for specific model

Body parameter

{}

Parameters

NameInTypeRequiredDescription
model_uuidpathstringtrueUUID of model
bodybodyModelContentRequestBodytruenone

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelContentResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelPredictRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models//predict \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"input_data":"{a:1, b:2}","input_type":"json"}'

POST /models/{model_uuid}/predict

Predicting specific model with custom input data

Body parameter

{
  "input_data": "{a:1, b:2}",
  "input_type": "json"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of model
bodybodyModelPredictRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelPredictResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_path":"\"myfolder/model.h5\"","run_uuid":"string"}'

POST /models/register

Register specific model to dq0 quarantine

Body parameter

{
  "model_path": "\"myfolder/model.h5\"",
  "run_uuid": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyModelRegisterRequestBodytruenone

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelRegisterResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ModelUnregisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/unregister \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_uuid":"string"}'

POST /models/unregister

Unregister specific model to dq0 quarantine

Body parameter

{
  "model_uuid": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyModelUnregisterRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureModelUnregisterResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

privacy

PrivacyBudgetListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/budgets \
  --header 'Accept: application/json'

GET /privacy/budgets

Lists all available PrivacyBudgets

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
data_idqueryinteger(int64)falsenone

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "current": 0,
      "data_id": 0,
      "data_name": "string",
      "initial": 0,
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structurePrivacyBudgetListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

PrivacyBudgetSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/budgets \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"current":1000,"data_id":1,"data_name":"owners"}'

POST /privacy/budgets

SetPrivacyBudget for data

Body parameter

{
  "current": 1000,
  "data_id": 1,
  "data_name": "owners"
}

Parameters

NameInTypeRequiredDescription
bodybodyPrivacyBudgetPermissionSetRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structurePrivacyBudgetPermissionSetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

PrivacyMaskListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/masks \
  --header 'Accept: application/json'

GET /privacy/masks

Lists all available PrivacyMasks

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
data_idqueryinteger(int64)falsenone

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_id": 0,
      "data_name": "string",
      "hidden": "string",
      "private": "string",
      "public": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structurePrivacyMaskListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

PrivacyMaskSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/masks \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"owners","mask_data":{},"user_email":"1","user_id":1}'

POST /privacy/masks

SetPrivacyMask for data

Body parameter

{
  "data_id": 1,
  "data_name": "owners",
  "mask_data": {},
  "user_email": "1",
  "user_id": 1
}

Parameters

NameInTypeRequiredDescription
bodybodyPrivacyMaskPermissionSetRequestBodytruenone

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

StatusMeaningDescriptionSchema
200OKnoneNone
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

PrivacyThresholdListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/thresholds \
  --header 'Accept: application/json'

GET /privacy/thresholds

Lists all available PrivacyThresholds

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
data_idqueryinteger(int64)falsenone

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_id": 0,
      "data_name": "string",
      "field": "string",
      "threshold": 0,
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structurePrivacyThresholdListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

PrivacyThresholdSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/thresholds \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"owners","field":"households","threshold":75,"user_email":"1","user_id":1}'

POST /privacy/thresholds

SetPrivacyThreshold for data

Body parameter

{
  "data_id": 1,
  "data_name": "owners",
  "field": "households",
  "threshold": 75,
  "user_email": "1",
  "user_id": 1
}

Parameters

NameInTypeRequiredDescription
bodybodyPrivacyThresholdPermissionSetRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structurePrivacyThresholdPermissionSetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

projects

ProjectSetPermissionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/projects \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"permission":4,"project_id":1,"project_name":"Project1","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2","role_id":1,"role_name":"owners"}'

GET /projects

SetPermissions all available projects

Body parameter

{
  "permission": 4,
  "project_id": 1,
  "project_name": "Project1",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2",
  "role_id": 1,
  "role_name": "owners"
}

Parameters

NameInTypeRequiredDescription
bodybodyProjectSetPermissionRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectSetPermissionResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"MyProject","working_dir":"/path/to/my/workingDir"}'

POST /projects

Creates new project

Body parameter

{
  "name": "MyProject",
  "working_dir": "/path/to/my/workingDir"
}

Parameters

NameInTypeRequiredDescription
bodybodyProjectCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectUnlinkRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/projects/ \
  --header 'Accept: application/json'

DELETE /projects/{project_uuid}

Removes specific project from local project list (does not actually delete the project files)

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of project

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

StatusMeaningDescriptionSchema
200OKnoneNone
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/projects/ \
  --header 'Accept: application/json'

GET /projects/{project_uuid}

Get information for specific project

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectDeployRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//deploy \
  --header 'Accept: application/json'

POST /projects/{project_uuid}/deploy

Deploys specific projects to dq0 quarantine

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of project

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

StatusMeaningDescriptionSchema
200OKnoneNone
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectDetachRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//detach \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_name":"census","data_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /projects/{project_uuid}/detach

Detach dataset to specific project

Body parameter

{
  "data_name": "census",
  "data_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of project
bodybodyProjectDetachRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectDetachResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectSetExperimentNameRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//set-experiment-name \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

POST /projects/{project_uuid}/set-experiment-name

Sets the experiment name for specific project uuid

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of project
bodybodyProjectSetExperimentNameRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectSetExperimentNameResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProjectAttachRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects/string/attach \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_name":"census","data_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /projects/{uuid}/attach

Attach dataset to specific project

Body parameter

{
  "data_name": "census",
  "data_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of project
bodybodyProjectAttachRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProjectAttachResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

proxies

ProxyListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies \
  --header 'Accept: application/json'

GET /proxies

Lists all available proxy instances

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page

Example responses

200 Response

{
  "items": [
    {
      "active": true,
      "email_address": "string",
      "hostname": "string",
      "port": 0,
      "public_key": "string",
      "request_uri": "string",
      "scheme": "string",
      "session_key": "string"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProxyListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProxyCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/proxies \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"hostname":"string","port":0,"request_uri":"string","scheme":"string"}'

POST /proxies

Adds new proxy entry

Body parameter

{
  "hostname": "string",
  "port": 0,
  "request_uri": "string",
  "scheme": "string"
}

Parameters

NameInTypeRequiredDescription
bodybodyProxyCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKProxy Create response structProxyCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProxyDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/proxies/string \
  --header 'Accept: application/json'

DELETE /proxies/{id}

Remove specific proxy instance from list

Parameters

NameInTypeRequiredDescription
idpathstringtrueID of proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProxyDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProxyGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies/string \
  --header 'Accept: application/json'

GET /proxies/{id}

Get detail information for specific proxy

Parameters

NameInTypeRequiredDescription
idpathstringtrueID of proxy

Example responses

200 Response

{
  "active": true,
  "email_address": "string",
  "hostname": "string",
  "port": 0,
  "public_key": "string",
  "request_uri": "string",
  "scheme": "string",
  "session_key": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProxyGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProxyActivateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/proxies/string/activate \
  --header 'Accept: application/json'

POST /proxies/{id}/activate

Activate existing proxy by id

Parameters

NameInTypeRequiredDescription
idpathstringtrueID of proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProxyActivateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

ProxiesCurrentRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies/current \
  --header 'Accept: application/json'

GET /proxies/current

Get current activated proxy instance

Example responses

200 Response

{
  "active": true,
  "email_address": "string",
  "hostname": "string",
  "port": 0,
  "public_key": "string",
  "request_uri": "string",
  "scheme": "string",
  "session_key": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureProxyCurrentResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

queries

QueryListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/queries \
  --header 'Accept: application/json'

GET /queries

Lists all available queries.

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureQueryListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

QueryCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/queries \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"datasets":"\"data_source1,data2\"","epsilon":1,"params":"p1=123","permissions":"households<75","private_column":"\"user_id\"","query":"SELECT COUNT(*) FROM table;","tau":100}'

POST /queries

Creates new query request

Body parameter

{
  "datasets": "\"data_source1,data2\"",
  "epsilon": 1,
  "params": "p1=123",
  "permissions": "households<75",
  "private_column": "\"user_id\"",
  "query": "SELECT COUNT(*) FROM table;",
  "tau": 100
}

Parameters

NameInTypeRequiredDescription
bodybodyQueryCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureQueryCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

QueryInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/queries/ \
  --header 'Accept: application/json'

GET /queries/{query_uuid}

Get information for specific query

Parameters

NameInTypeRequiredDescription
include_runquerybooleanfalseSet to include run meta information for this query
include_resultquerybooleanfalseSet to include results for this query

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "query_datasets": {
    "property1": "string",
    "property2": "string"
  },
  "query_result_data": "string",
  "query_result_message": "string",
  "query_statement": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureQueryInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

QueryCancelRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/queries//cancel \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"force":false,"query_uuid":"79ef8712-f3ed-4494-bb34-aa44fe0f000a"}'

POST /queries/{query_uuid}/cancel

Cancel a ongoing query

Body parameter

{
  "force": false,
  "query_uuid": "79ef8712-f3ed-4494-bb34-aa44fe0f000a"
}

Parameters

NameInTypeRequiredDescription
uuidpathstringtrueUUID of query
bodybodyQueryCancelRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureQueryCancelResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

roles

RoleSetPermissionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"permission":4,"role_id":1,"role_name":"owners"}'

GET /roles

SetPermissions all available roles

Body parameter

{
  "permission": 4,
  "role_id": 1,
  "role_name": "owners"
}

Parameters

NameInTypeRequiredDescription
bodybodyRoleSetPermissionRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRoleSetPermissionResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RoleCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_name":"Admin, User"}'

POST /roles

Creates new role

Body parameter

{
  "role_name": "Admin, User"
}

Parameters

NameInTypeRequiredDescription
bodybodyRoleCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRoleCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RoleDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/roles/string \
  --header 'Accept: application/json'

DELETE /roles/{role_id}

Remove specific role instance by id

Parameters

NameInTypeRequiredDescription
role_idpathstringtrueID of Role

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRoleDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RoleGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/roles/string \
  --header 'Accept: application/json'

GET /roles/{role_id}

Get detail information for specific Role

Parameters

NameInTypeRequiredDescription
role_idpathstringtrueID of Role

Example responses

200 Response

{
  "created_at": 0,
  "role_id": 0,
  "role_name": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRoleGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RolePatchRequest

Code samples

curl --request PATCH \
  --url 'http://localhost:9000/api/roles/0?role_id=0' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_name":"MyRole"}'

PATCH /roles/{role_id}

Update a specific Role

Body parameter

{
  "role_name": "MyRole"
}

Parameters

NameInTypeRequiredDescription
role_idqueryinteger(int64)trueID of Role
bodybodyRolePatchRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "role_id": 0,
  "role_name": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRolePatchResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

runs

RunListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs \
  --header 'Accept: application/json'

GET /runs

Lists all available runs

Parameters

NameInTypeRequiredDescription
pagequeryinteger(int64)falseSet ‘page’ to page through the results list
page_sizequeryinteger(int64)falseSet ‘page-size’ to set the number of result items per page
order_byquerystringfalseSet ‘order_by’ to sort list items
user_idqueryinteger(int64)falseUser id to filter list for
project_uuidquerystringfalseUUID of project
commit_uuidquerystringfalseUUID of commit (filter by this uuid only)
experiment_uuidquerystringfalseUUID of experiment (filter by this uuid only)

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunListResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RunCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/runs \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"args":{"property1":"string","property2":"string"},"commit_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2","ml_project_entry_point":"train","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /runs

Creates new run

Body parameter

{
  "args": {
    "property1": "string",
    "property2": "string"
  },
  "commit_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2",
  "ml_project_entry_point": "train",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

NameInTypeRequiredDescription
bodybodyRunCreateRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunCreateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RunDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/runs/ \
  --header 'Accept: application/json'

DELETE /runs/{run_uuid}

Return information for specific run

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RunInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs/ \
  --header 'Accept: application/json'

GET /runs/{run_uuid}

Get information for specific run

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunInfoResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RunGetMetricHistoryRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs//metric_history \
  --header 'Accept: application/json'

GET /runs/{run_uuid}/metric_history

Get metric history values from specific run

Parameters

NameInTypeRequiredDescription
metric_keyquerystringfalseMetric Key

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunGetMetricHistoryResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

RunRestoreRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/runs//restore \
  --header 'Accept: application/json'

POST /runs/{run_uuid}/restore

Restores specific run

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureRunRestoreResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

users

UserDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/user/ \
  --header 'Accept: application/json'

DELETE /user/{id}

Remove specific User instance from list

Parameters

NameInTypeRequiredDescription
user_idpathstringtrueID of User

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserDeleteResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserRemoveRoleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_id":4,"role_name":"owners","user_email":"owners","user_id":1,"user_name":"owners"}'

GET /users

RemoveRoles all available users

Body parameter

{
  "role_id": 4,
  "role_name": "owners",
  "user_email": "owners",
  "user_id": 1,
  "user_name": "owners"
}

Parameters

NameInTypeRequiredDescription
bodybodyUserRemoveRoleRequestBodytruenone

Example responses

200 Response

{}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserRemoveRoleResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/string \
  --header 'Accept: application/json'

GET /users/{user_id}

Get detail information for specific user

Parameters

NameInTypeRequiredDescription
user_idpathstringtrueID of user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserUpdateRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/users/0 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"roles":[0],"state":"string"}'

PATCH /users/{user_id}

Update a specific user

Body parameter

{
  "roles": [
    0
  ],
  "state": "string"
}

Parameters

NameInTypeRequiredDescription
user_idpathinteger(int64)trueUserID of user
bodybodyUserUpdateRequestBodytruenone

Example responses

200 Response

{
  "created_at": 0,
  "email": "string",
  "id": 0,
  "password": "string",
  "role": 0,
  "role_name": "string",
  "state": "string",
  "updated_at": 0
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserUpdateResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserLoginRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /users/login

Login user in quarantine through current proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

NameInTypeRequiredDescription
bodybodyUserLoginRequestBodytruenone

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserLoginResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserLogoutRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/logout \
  --header 'Accept: application/json'

POST /users/logout

Logout user in quarantine through current proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserLogoutResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserProfileCurrentRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/profile \
  --header 'Accept: application/json'

GET /users/profile

Get detail profile information for current user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserProfileGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/profile/ \
  --header 'Accept: application/json'

GET /users/profile/{user_id}

Get detail profile information for specific user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserGetResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /users/register

Register user in activated proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

NameInTypeRequiredDescription
bodybodyUserRegisterRequestBodytruenone

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserRegisterResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

UserSessionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/session \
  --header 'Accept: application/json'

GET /users/session

Get current activated proxy session

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

StatusMeaningDescriptionSchema
200OKResponse structureUserSessionResponseBody
defaultDefaultGenericErrorResponse contains a ‘error’ field onlyError

This operation does not require authentication

Schemas

ActionItem

action_id: 0
action_name: string
action_next_page_token: string

Properties

NameTypeRequiredRestrictionsDescription
action_idinteger(int64)falsenonenone
action_namestringfalsenonenone
action_next_page_tokenstringfalsenonenone

ActionListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[ActionItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ActionPermissionSetRequestBody

action: UserRegister
action_id: 1
permission: 4
role_id: 1
role_name: admin

Properties

NameTypeRequiredRestrictionsDescription
actionstringfalsenoneAction Name
action_idinteger(int64)falsenoneAction ID
permissioninteger(int64)falsenonePermissionLevel
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRole Name

ActionPermissionSetResponseBody

{}

Properties

None

ArtifactDownloadResponseBody

data_path: '"out_file.txt"'
data_string: "[]"

Properties

NameTypeRequiredRestrictionsDescription
data_pathstringtruenonePath to this artifact
data_stringstringtruenoneData as string

ArtifactFile

children:
  - children: []
    file_size: string
    header: string
    is_dir: true
    label: string
    path: string
file_size: string
header: string
is_dir: true
label: string
path: string

ArtifactFile struct

Properties

NameTypeRequiredRestrictionsDescription
children[ArtifactFile]falsenone[ArtifactFile struct]
file_sizestringfalsenonenone
headerstringfalsenonenone
is_dirbooleanfalsenonenone
labelstringfalsenonenone
pathstringfalsenonenone

ArtifactTreeStructureResponseBody

artifact_files:
  - children:
      - {}
    file_size: string
    header: string
    is_dir: true
    label: string
    path: string
artifact_next_page_token: string
commit_name: string
commit_uuid: string
experiment_name: string
experiment_uuid: string
job_name: string
job_uuid: string
project_name: string
project_uuid: string
run_id: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
artifact_files[ArtifactFile]falsenone[ArtifactFile struct]
artifact_next_page_tokenstringfalsenonenone
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
job_namestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
run_idstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

AuditListItem

action: '"model.deploy"'
actor: '"user@dq0.io" or "system"'
description: "\"model with uuid 'c4a790eb-104f-48bf-97b3-ba5d5ffa8d95' and
  version 'da0a84e9-29f9-4cf3-a0a2-54aa39c82c64' deployed\""
timestamp: '"1589786433"'

Properties

NameTypeRequiredRestrictionsDescription
actionstringfalsenoneAction identifier: type of event
actorstringfalsenoneEmail / Identifier of the actor (creator of an audit entry)
descriptionstringfalsenoneAudit description
timestampstringfalsenoneUnix timestamp in seconds

AuditListResponseBody

items:
  - action: auth.login
    actor: user@dq0.io
    description: user with email 'user@dq0.io' and device
      '78e1e9d4-cc8c-48da-a325-1c0f908cd9a5' logged in successfully
    timestamp: "1587463859"
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[AuditListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

AuthLoginRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

NameTypeRequiredRestrictionsDescription
emailstringfalsenoneEmail address
passwordstringfalsenonePassword in plain text (will be encrypted)

AuthLoginResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

NameTypeRequiredRestrictionsDescription
tokenstringfalsenoneToken identifying current session

AuthLogoutResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

AuthRegisterRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

NameTypeRequiredRestrictionsDescription
emailstringfalsenoneEmail address
passwordstringfalsenonePassword in plain text (will be encrypted)

AuthRegisterResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

AuthSessionResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

NameTypeRequiredRestrictionsDescription
tokenstringfalsenoneToken identifying current session

CommitContentRequestBody

local_only: true
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
local_onlybooleanfalsenoneread only local project
project_uuidstringfalsenoneUUID of project

CommitContentResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

CommitInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

CommitItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

CommitListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[CommitItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

CommitRunRequestBody

args:
  property1: string
  property2: string
ml_project_entry_point: train
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
argsobjectfalsenoneArguments to pass for this run
» additionalPropertiesstringfalsenonenone
ml_project_entry_pointstringfalsenoneMLproject entry point
project_uuidstringfalsenoneUUID of project

CommitRunResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

CommitTransformRequestBody

project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
project_uuidstringfalsenoneUUID of project

CommitTransformResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

DataCreateRequestBody

meta: string

Properties

NameTypeRequiredRestrictionsDescription
metastringfalsenoneMeta yaml content for data set definition

DataCreateResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
data_descriptionstringfalsenonenone
data_meanstringfalsenonenone
data_namestringfalsenonenone
data_permissions[string]falsenonenone
data_samplestringfalsenonenone
data_sizeinteger(int64)falsenonenone
data_statsstringfalsenonenone
data_stdstringfalsenonenone
data_typestringfalsenonenone
data_usagenumber(double)falsenonenone
data_uuidstringfalsenonenone
privacy_budgetinteger(int64)falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

DataDeleteResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
data_descriptionstringfalsenonenone
data_meanstringfalsenonenone
data_namestringfalsenonenone
data_permissions[string]falsenonenone
data_samplestringfalsenonenone
data_sizeinteger(int64)falsenonenone
data_statsstringfalsenonenone
data_stdstringfalsenonenone
data_typestringfalsenonenone
data_usagenumber(double)falsenonenone
data_uuidstringfalsenonenone
privacy_budgetinteger(int64)falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

DataGetResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
data_descriptionstringfalsenonenone
data_meanstringfalsenonenone
data_namestringfalsenonenone
data_permissions[string]falsenonenone
data_samplestringfalsenonenone
data_sizeinteger(int64)falsenonenone
data_statsstringfalsenonenone
data_stdstringfalsenonenone
data_typestringfalsenonenone
data_usagenumber(double)falsenonenone
data_uuidstringfalsenonenone
privacy_budgetinteger(int64)falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

DataItem

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
data_descriptionstringfalsenonenone
data_meanstringfalsenonenone
data_namestringfalsenonenone
data_permissions[string]falsenonenone
data_samplestringfalsenonenone
data_sizeinteger(int64)falsenonenone
data_statsstringfalsenonenone
data_stdstringfalsenonenone
data_typestringfalsenonenone
data_usagenumber(double)falsenonenone
data_uuidstringfalsenonenone
privacy_budgetinteger(int64)falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

DataListResponseBody

items: "'[{\"id\":1,\"uuid\":\"78fbda3a-6530-45ba-83b0-fe2d7dda899d\",\"name\":\
  \"source
  1\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\",\\
  "sample\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source\
  1.csv\",\"size\":4,\"mean\":\"(-23.538887188473396, 4.5820969395656865,
  10.53646357964901, 7.1721683055053)\",\"std\":\"(8.79595482855613,
  15.038949447047374, 15.76694875021541,
  55.907788290107405)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"202\
  0-03-24 08:50:57.175\",\"updated_at\":\"2020-04-06
  07:05:05.079\"},{\"id\":2,\"uuid\":\"a87e55d0-aa7c-41c8-9147-1f69b16accc2\",\\
  "name\":\"source
  2\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\
  \"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source2.csv\",\"s\
  ize\":5,\"mean\":\"(-64.64820261903593, 45.56088456347706, 44.27540826516029,
  0.8988506631702773, -43.96628296178475)\",\"std\":\"(38.296517680818894,
  18.843032606250475, 30.83218542407734, 39.104564678591636,
  62.714621754899326)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"202\
  0-03-24 08:50:57.176\",\"updated_at\":\"2020-04-06
  07:05:05.08\"},{\"id\":3,\"uuid\":\"1d3c0ed7-a092-4ce6-b947-55a376dc312b\",\"\
  name\":\"source
  3\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\
  \"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source3.csv\",\"s\
  ize\":5323669,\"mean\":\"(0.2964112953231287, 0.12005084567531446,
  0.6048137927357801, 0.014094863934083933, 0.02116986459954208,
  0.40440611493306095, 0.029147126455147773, 0.0650217121756085,
  0.00026026997636017146, 0.016913810102030358, 0.0019003011109808422,
  0.0005982953058642256, 0.23932725135030042)\",\"std\":\"(0.18807155928503272,
  0.07656611702507954, 0.1709745075446674, 0.06317847401767661,
  0.09497729877421364, 0.12309145556565027, 0.17006894010079007,
  0.24460727006477984, 0.009326928792466644, 0.4608292162296523,
  0.17959469088151425, 0.26998778640743437,
  0.19910365111781858)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"20\
  20-03-26 08:28:01.871\",\"updated_at\":\"2020-04-06 07:05:05.08\"}]'"
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[DataItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

DataPatchRequestBody

meta: string

Properties

NameTypeRequiredRestrictionsDescription
metastringfalsenoneMeta yaml definition of data set

DataPatchResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
data_descriptionstringfalsenonenone
data_meanstringfalsenonenone
data_namestringfalsenonenone
data_permissions[string]falsenonenone
data_samplestringfalsenonenone
data_sizeinteger(int64)falsenonenone
data_statsstringfalsenonenone
data_stdstringfalsenonenone
data_typestringfalsenonenone
data_usagenumber(double)falsenonenone
data_uuidstringfalsenonenone
privacy_budgetinteger(int64)falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

DataPermissionSetRequestBody

data_id: 1
data_name: census
data_uuid: string
permission: 4
role_id: 1
role_name: admins

Properties

NameTypeRequiredRestrictionsDescription
data_idinteger(int64)falsenoneData ID
data_namestringfalsenoneData Name
data_uuidstringfalsenoneData UUID
permissioninteger(int64)falsenonePermissionLevel
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRole Name

DataPermissionSetResponseBody

{}

Properties

None

DataSampleResponseBody

name: census
sample: '[{"lastname":"Lastname282","firstname":"Firstname928","age":24,"workclass":"Private","fnlwgt":157177,"education":"Masters","education-num":14,"marital-status":"Married-civ-spouse","occupation":"Prof-specialty","relationship":"Husband","race":"White","sex":"Male","capital-gain":0,"capital-loss":0,"hours-per-week":50,"native-country":"United-States","income":"<=50K"}]'
type: csv
uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
namestringfalsenoneName of dataset
samplestringfalsenoneSample of dataset as string
typestringfalsenoneType of dataset
uuidstringfalsenoneUUID of dataset

DeviceVersionResponseBody

api_version: 1.2.6
architecture: amd64
built: 2020-05-28T09:55:02Z
cli_version: 1.1.0
os: darwin

Properties

NameTypeRequiredRestrictionsDescription
api_versionstringfalsenoneAPI version information
architecturestringfalsenoneOperating System architecture information
builtstringfalsenoneBuilt timestamp information
cli_versionstringfalsenoneCLI version information
osstringfalsenoneOperating System information

Error

error: invalid parameters provided

Properties

NameTypeRequiredRestrictionsDescription
errorstringtruenoneThe error message

ExperimentCreateRequestBody

experiment_name: My Cool Experiment 42

Properties

NameTypeRequiredRestrictionsDescription
experiment_namestringfalsenoneName of the experiment

ExperimentCreateResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ExperimentDeleteResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ExperimentInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ExperimentListItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ExperimentListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[ExperimentListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ExperimentRestoreResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ExperimentUpdateRequestBody

experiment_name: My Cool Experiment 42

Properties

NameTypeRequiredRestrictionsDescription
experiment_namestringfalsenoneName of the experiment

ExperimentUpdateResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

GroupAddRoleRequestBody

group_id: 1
group_name: owners
role_id: 4
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroup ID
group_namestringfalsenoneGroup Name
role_idinteger(int64)falsenoneRoleID
role_namestringfalsenoneRoleName

GroupAddRoleResponseBody

{}

Properties

None

GroupCreateRequestBody

group_name: Admin, User

Properties

NameTypeRequiredRestrictionsDescription
group_namestringfalsenoneName of the new Group

GroupCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

GroupDeleteResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

GroupGetResponseBody

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
group_idinteger(int64)falsenonenone
group_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

GroupListItem

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
group_idinteger(int64)falsenonenone
group_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

GroupListResponseBody

items:
  - created_at: 0
    group_id: 0
    group_name: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[GroupListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

GroupPatchRequestBody

group_name: MyGroup

Properties

NameTypeRequiredRestrictionsDescription
group_namestringfalsenoneName of Group

GroupPatchResponseBody

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
group_idinteger(int64)falsenonenone
group_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

GroupRemoveRoleRequestBody

group_id: 1
group_name: owners
role_id: 4
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroup ID
group_namestringfalsenoneGroup Name
role_idinteger(int64)falsenoneRoleID
role_namestringfalsenoneRoleName

GroupRemoveRoleResponseBody

{}

Properties

None

JobCancelRequestBody

force: false
job_uuid: 79ef8712-f3ed-4494-bb34-aa44fe0f000a

Properties

NameTypeRequiredRestrictionsDescription
forcebooleanfalsenoneForce cancelation
job_uuidstringfalsenoneUUID of job to cancel

JobCancelResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

JobInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

JobItem

commit_name: string
commit_uuid: string
created_at: 0
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

JobListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[JobItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ModelContentRequestBody

{}

Properties

None

ModelContentResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
descriptionstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
locationstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
permissions[string]falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

ModelInfoResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
descriptionstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
locationstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
permissions[string]falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

ModelItem

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
descriptionstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
locationstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
permissions[string]falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

ModelListResponseBody

items:
  - commit_name: string
    commit_uuid: string
    description: string
    experiment_name: string
    experiment_uuid: string
    location: string
    model_name: string
    model_uuid: string
    permissions:
      - string
    project_name: string
    project_uuid: string
    user_id: 0
    user_name: string
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[ModelItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ModelPatchRequestBody

model_description: '"Model with trained stuff that is crazy"'
model_name: '"myModel123"'
permissions: "['predict_allowed', 'predict_proba_allowed']"

Properties

NameTypeRequiredRestrictionsDescription
model_descriptionstringfalsenoneDescription for this model
model_namestringfalsenoneName for this model
permissions[string]falsenonePermissions of dataset. Values are:
predict_allowed: allow to predict
predict_proba_allowed: allow to predict proba

ModelPatchResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
descriptionstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
locationstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
permissions[string]falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

ModelPredictRequestBody

input_data: "{a:1, b:2}"
input_type: json

Properties

NameTypeRequiredRestrictionsDescription
input_datastringfalsenonePath to input file
input_typestringfalsenoneType either json or csv

ModelPredictResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ModelRegisterRequestBody

model_path: '"myfolder/model.h5"'
run_uuid: string

Properties

NameTypeRequiredRestrictionsDescription
model_pathstringfalsenonePath to model
run_uuidstringtruenoneUUID of run (=job uuid)

in: path

ModelRegisterResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
descriptionstringfalsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenonenone
locationstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
permissions[string]falsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

ModelUnregisterRequestBody

model_uuid: string

Properties

NameTypeRequiredRestrictionsDescription
model_uuidstringtruenoneUUID of model

in: path

ModelUnregisterResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

PrivacyBudgetListItem

created_at: 0
current: 0
data_id: 0
data_name: string
initial: 0
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
currentnumber(double)falsenonenone
data_idinteger(int64)falsenonenone
data_namestringfalsenonenone
initialnumber(double)falsenonenone
updated_atinteger(int64)falsenonenone

PrivacyBudgetListResponseBody

items:
  - created_at: 0
    current: 0
    data_id: 0
    data_name: string
    initial: 0
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[PrivacyBudgetListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

PrivacyBudgetPermissionSetRequestBody

current: 1000
data_id: 1
data_name: owners

Properties

NameTypeRequiredRestrictionsDescription
currentnumber(double)falsenoneCurrent (or initial) Budget
data_idinteger(int64)falsenoneData ID
data_namestringfalsenoneDataName

PrivacyBudgetPermissionSetResponseBody

{}

Properties

None

PrivacyMaskListItem

created_at: 0
data_id: 0
data_name: string
hidden: string
private: string
public: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_idinteger(int64)falsenonenone
data_namestringfalsenonenone
hiddenstringfalsenonenone
privatestringfalsenonenone
publicstringfalsenonenone
updated_atinteger(int64)falsenonenone

PrivacyMaskListResponseBody

items:
  - created_at: 0
    data_id: 0
    data_name: string
    hidden: string
    private: string
    public: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[PrivacyMaskListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

PrivacyMaskPermissionSetRequestBody

data_id: 1
data_name: owners
mask_data: {}
user_email: "1"
user_id: 1

Properties

NameTypeRequiredRestrictionsDescription
data_idinteger(int64)falsenoneData ID
data_namestringfalsenoneDataName
mask_dataobjectfalsenoneJSON encoded data containing information about column masking
user_emailstringfalsenoneUserEmail
user_idinteger(int64)falsenoneUser ID

PrivacyMaskPermissionSetResponseBody

{}

Properties

None

PrivacyThresholdListItem

created_at: 0
data_id: 0
data_name: string
field: string
threshold: 0
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_idinteger(int64)falsenonenone
data_namestringfalsenonenone
fieldstringfalsenonenone
thresholdinteger(int64)falsenonenone
updated_atinteger(int64)falsenonenone

PrivacyThresholdListResponseBody

items:
  - created_at: 0
    data_id: 0
    data_name: string
    field: string
    threshold: 0
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[PrivacyThresholdListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

PrivacyThresholdPermissionSetRequestBody

data_id: 1
data_name: owners
field: households
threshold: 75
user_email: "1"
user_id: 1

Properties

NameTypeRequiredRestrictionsDescription
data_idinteger(int64)falsenoneData ID
data_namestringfalsenoneDataName
fieldstringfalsenoneColumn, column name
thresholdinteger(int64)falsenoneThreshold value
user_emailstringfalsenoneUserEmail
user_idinteger(int64)falsenoneUser ID

PrivacyThresholdPermissionSetResponseBody

{}

Properties

None

ProjectAttachRequestBody

data_name: census
data_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
data_namestringfalsenoneName of dataset
data_uuidstringfalsenoneUUID of dataset

ProjectAttachResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProjectCreateRequestBody

name: MyProject
working_dir: /path/to/my/workingDir

Properties

NameTypeRequiredRestrictionsDescription
namestringfalsenoneName of your new project
working_dirstringfalsenoneWorking directory path

ProjectCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProjectDeployResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProjectDetachRequestBody

data_name: census
data_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
data_namestringfalsenoneName of dataset
data_uuidstringfalsenoneUUID of dataset

ProjectDetachResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProjectInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ProjectItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
data_namestringfalsenonenone
data_uuidstringfalsenonenone
latest_experiment_namestringfalsenonenone
latest_experiment_resultstringfalsenonenone
latest_experiment_uuidstringfalsenonenone
model_checker_statusstringfalsenonenone
model_namestringfalsenonenone
model_uuidstringfalsenonenone
predict_allowedbooleanfalsenonenone
predict_proba_allowedbooleanfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
updated_atinteger(int64)falsenonenone

ProjectListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[ProjectItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ProjectSetExperimentNameRequestBody

experiment_name: My Cool Experiment 42

Properties

NameTypeRequiredRestrictionsDescription
experiment_namestringfalsenoneName of the experiment

ProjectSetExperimentNameResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProjectSetPermissionRequestBody

permission: 4
project_id: 1
project_name: Project1
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2
role_id: 1
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
permissioninteger(int64)falsenonePermissionLevel
project_idinteger(int64)falsenoneProject ID
project_namestringfalsenoneProject Name
project_uuidstringfalsenoneProject UUID
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRoleName

ProjectSetPermissionResponseBody

{}

Properties

None

ProjectUnlinkResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProxyActivateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProxyCreateRequestBody

hostname: string
port: 0
request_uri: string
scheme: string

Properties

NameTypeRequiredRestrictionsDescription
hostnamestringfalsenonenone
portinteger(int64)falsenonenone
request_uristringfalsenonenone
schemestringfalsenonenone

ProxyCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProxyCurrentResponseBody

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

NameTypeRequiredRestrictionsDescription
activebooleanfalsenonenone
email_addressstringfalsenonenone
hostnamestringfalsenonenone
portinteger(int64)falsenonenone
public_keystringfalsenonenone
request_uristringfalsenonenone
schemestringfalsenonenone
session_keystringfalsenonenone

ProxyDeleteResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

ProxyGetResponseBody

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

NameTypeRequiredRestrictionsDescription
activebooleanfalsenonenone
email_addressstringfalsenonenone
hostnamestringfalsenonenone
portinteger(int64)falsenonenone
public_keystringfalsenonenone
request_uristringfalsenonenone
schemestringfalsenonenone
session_keystringfalsenonenone

ProxyListResponseBody

items:
  - active: true
    email_address: string
    hostname: string
    port: 0
    public_key: string
    request_uri: string
    scheme: string
    session_key: string
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[ProxyResultItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

ProxyResultItem

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

NameTypeRequiredRestrictionsDescription
activebooleanfalsenonenone
email_addressstringfalsenonenone
hostnamestringfalsenonenone
portinteger(int64)falsenonenone
public_keystringfalsenonenone
request_uristringfalsenonenone
schemestringfalsenonenone
session_keystringfalsenonenone

QueryCancelRequestBody

force: false
query_uuid: 79ef8712-f3ed-4494-bb34-aa44fe0f000a

Properties

NameTypeRequiredRestrictionsDescription
forcebooleanfalsenoneForce cancelation
query_uuidstringfalsenoneUUID of query to cancel

QueryCancelResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

QueryCreateRequestBody

datasets: '"data_source1,data2"'
epsilon: 1
params: p1=123
permissions: households<75
private_column: '"user_id"'
query: SELECT COUNT(*) FROM table;
tau: 100

Properties

NameTypeRequiredRestrictionsDescription
datasetsstringfalsenoneUsed dataset uuid for provided query
epsilonnumber(double)falsenoneEpsilon value for differential private query.
params[string]falsenoneAdditional parameters
permissions[string]falsenonePermissions for provided query
private_columnstringfalsenonePrivate column for this query. Leave empty or omit for default value from metadata.
querystringfalsenoneSQL query to execute
taunumber(double)falsenoneTau threshold value for private query. Optional.

QueryCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

QueryInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
query_datasets:
  property1: string
  property2: string
query_result_data: string
query_result_message: string
query_statement: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenoneadditional meta information: experiment
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
query_datasetsobjectfalsenonenone
» additionalPropertiesstringfalsenonenone
query_result_datastringfalsenonenone
query_result_messagestringfalsenonenone
query_statementstringfalsenonenone
run_end_timeinteger(int64)falsenonenone
run_metrics[RunMetricItem]falsenone[RunMetricItem model struct]
run_params[RunParamItem]falsenone[RunParamItem model struct]
run_stagestringfalsenonenone
run_start_timeinteger(int64)falsenonenone
run_statusstringfalsenonenone
run_tags[RunTagItem]falsenone[RunTagItem model struct]
run_uuidstringfalsenonerun info
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

QueryItem

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
query_datasets:
  property1: string
  property2: string
query_result_data: string
query_result_message: string
query_statement: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenoneadditional meta information: experiment
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
query_datasetsobjectfalsenonenone
» additionalPropertiesstringfalsenonenone
query_result_datastringfalsenonenone
query_result_messagestringfalsenonenone
query_statementstringfalsenonenone
run_end_timeinteger(int64)falsenonenone
run_metrics[RunMetricItem]falsenone[RunMetricItem model struct]
run_params[RunParamItem]falsenone[RunParamItem model struct]
run_stagestringfalsenonenone
run_start_timeinteger(int64)falsenonenone
run_statusstringfalsenonenone
run_tags[RunTagItem]falsenone[RunTagItem model struct]
run_uuidstringfalsenonerun info
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

QueryListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[QueryItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

RoleAddGroupRequestBody

group_id: 4
group_name: owners
role_id: 1
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroupID
group_namestringfalsenoneGroup Name
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRoleName

RoleAddGroupResponseBody

{}

Properties

None

RoleCreateRequestBody

role_name: Admin, User

Properties

NameTypeRequiredRestrictionsDescription
role_namestringfalsenoneName of the new Role

RoleCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

RoleDeleteResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

RoleGetResponseBody

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
role_idinteger(int64)falsenonenone
role_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

RoleListItem

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
role_idinteger(int64)falsenonenone
role_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

RoleListResponseBody

items:
  - created_at: 0
    role_id: 0
    role_name: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[RoleListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

RolePatchRequestBody

role_name: MyRole

Properties

NameTypeRequiredRestrictionsDescription
role_namestringfalsenoneName of Role

RolePatchResponseBody

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
role_idinteger(int64)falsenonenone
role_namestringfalsenonenone
updated_atinteger(int64)falsenonenone

RoleRemoveGroupRequestBody

group_id: 4
group_name: owners
role_id: 1
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroupID
group_namestringfalsenoneGroup Name
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRoleName

RoleRemoveGroupResponseBody

{}

Properties

None

RoleSetPermissionRequestBody

permission: 4
role_id: 1
role_name: owners

Properties

NameTypeRequiredRestrictionsDescription
permissioninteger(int64)falsenonePermissionLevel
role_idinteger(int64)falsenoneRole ID
role_namestringfalsenoneRoleName

RoleSetPermissionResponseBody

{}

Properties

None

RunCreateRequestBody

args:
  property1: string
  property2: string
commit_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2
ml_project_entry_point: train
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

NameTypeRequiredRestrictionsDescription
argsobjectfalsenoneArguments to pass for this run
» additionalPropertiesstringfalsenonenone
commit_uuidstringfalsenoneUUID of commit
ml_project_entry_pointstringfalsenoneMLproject entry point
project_uuidstringfalsenoneUUID of project

RunCreateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

RunDeleteResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

RunGetMetricHistoryResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenoneadditional meta information: experiment
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
run_end_timeinteger(int64)falsenonenone
run_metrics[RunMetricItem]falsenone[RunMetricItem model struct]
run_params[RunParamItem]falsenone[RunParamItem model struct]
run_stagestringfalsenonenone
run_start_timeinteger(int64)falsenonenone
run_statusstringfalsenonenone
run_tags[RunTagItem]falsenone[RunTagItem model struct]
run_uuidstringfalsenonerun info
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

RunInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenoneadditional meta information: experiment
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
run_end_timeinteger(int64)falsenonenone
run_metrics[RunMetricItem]falsenone[RunMetricItem model struct]
run_params[RunParamItem]falsenone[RunParamItem model struct]
run_stagestringfalsenonenone
run_start_timeinteger(int64)falsenonenone
run_statusstringfalsenonenone
run_tags[RunTagItem]falsenone[RunTagItem model struct]
run_uuidstringfalsenonerun info
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

RunItem

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

NameTypeRequiredRestrictionsDescription
commit_namestringfalsenonenone
commit_uuidstringfalsenonenone
created_atinteger(int64)falsenonenone
experiment_namestringfalsenonenone
experiment_uuidstringfalsenoneadditional meta information: experiment
job_errorsstringfalsenonenone
job_logsstringfalsenonenone
job_namestringfalsenonenone
job_paramsstringfalsenonenone
job_progressnumber(double)falsenonenone
job_resultsstringfalsenonenone
job_statestringfalsenonenone
job_typestringfalsenonenone
job_uuidstringfalsenonenone
project_namestringfalsenonenone
project_uuidstringfalsenonenone
run_end_timeinteger(int64)falsenonenone
run_metrics[RunMetricItem]falsenone[RunMetricItem model struct]
run_params[RunParamItem]falsenone[RunParamItem model struct]
run_stagestringfalsenonenone
run_start_timeinteger(int64)falsenonenone
run_statusstringfalsenonenone
run_tags[RunTagItem]falsenone[RunTagItem model struct]
run_uuidstringfalsenonerun info
updated_atinteger(int64)falsenonenone
user_idinteger(int64)falsenonenone
user_namestringfalsenonenone

RunListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[RunItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

RunMetricItem

key: string
step: string
timestamp: string
value: 0

RunMetricItem model struct

Properties

NameTypeRequiredRestrictionsDescription
keystringfalsenonenone
stepstringfalsenonenone
timestampstringfalsenonenone
valuenumber(double)falsenonenone

RunParamItem

key: string
value: string

RunParamItem model struct

Properties

NameTypeRequiredRestrictionsDescription
keystringfalsenonenone
valuestringfalsenonenone

RunRestoreResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

RunTagItem

key: string
value: string

RunTagItem model struct

Properties

NameTypeRequiredRestrictionsDescription
keystringfalsenonenone
valuestringfalsenonenone

UserAddGroupRequestBody

group_id: 4
group_name: owners
user_email: owners
user_id: 1

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroupID
group_namestringfalsenoneGroup Name
user_emailstringfalsenoneUserEmail
user_idinteger(int64)falsenoneUser ID

UserAddGroupResponseBody

{}

Properties

None

UserAddRoleRequestBody

role_id: 4
role_name: owners
user_email: owners
user_id: 1
user_name: owners

Properties

NameTypeRequiredRestrictionsDescription
role_idinteger(int64)falsenoneRoleID
role_namestringfalsenoneRoleName
user_emailstringfalsenoneUser Email
user_idinteger(int64)falsenoneUser ID
user_namestringfalsenoneUser Name

UserAddRoleResponseBody

{}

Properties

None

UserDeleteResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

UserGetResponseBody

avatar: string
company: string
location: string
name: string
public_email: string
user_id: 0
website: string

Properties

NameTypeRequiredRestrictionsDescription
avatarstringfalsenonenone
companystringfalsenonenone
locationstringfalsenonenone
namestringfalsenonenone
public_emailstringfalsenonenone
user_idinteger(int64)falsenonenone
websitestringfalsenonenone

UserListItem

created_at: 0
email: string
id: 0
password: string
role: 0
role_name: string
state: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
emailstringfalsenonenone
idinteger(int64)falsenonenone
passwordstringfalsenonenone
roleinteger(int64)falsenonenone
role_namestringfalsenonenone
statestringfalsenonenone
updated_atinteger(int64)falsenonenone

UserListResponseBody

items:
  - created_at: 0
    email: string
    id: 0
    password: string
    role: 0
    role_name: string
    state: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

NameTypeRequiredRestrictionsDescription
items[UserListItem]truenoneArray with resulting items
pageinteger(int64)falsenoneCurrent page in result list
page_sizeinteger(int64)falsenoneNumber of records per page
totalinteger(int64)falsenoneNumber of total records available in database

UserLoginRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

NameTypeRequiredRestrictionsDescription
emailstringfalsenoneEmail address
passwordstringfalsenonePassword in plain text (will be encrypted)

UserLoginResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

NameTypeRequiredRestrictionsDescription
tokenstringfalsenoneToken identifying current session

UserLogoutResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

UserProfileCurrentResponseBody

avatar: string
company: string
location: string
name: string
public_email: string
user_id: 0
website: string

Properties

NameTypeRequiredRestrictionsDescription
avatarstringfalsenonenone
companystringfalsenonenone
locationstringfalsenonenone
namestringfalsenonenone
public_emailstringfalsenonenone
user_idinteger(int64)falsenonenone
websitestringfalsenonenone

UserProfileUpdateRequestBody

avatar: string
company: gradient0
location: Vienna
name: John
public_email: john@gmail.com
website: gradient0.com

Properties

NameTypeRequiredRestrictionsDescription
avatarstringfalsenoneAvatar

base64 encoded string
companystringfalsenoneCompany
locationstringfalsenoneLocation
namestringfalsenoneName
public_emailstringfalsenonePublic Email
websitestringfalsenoneWebsite

UserProfileUpdateResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

UserRegisterRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

NameTypeRequiredRestrictionsDescription
emailstringfalsenoneEmail address
passwordstringfalsenonePassword in plain text (will be encrypted)

UserRegisterResponseBody

message: succesfully started training ...

Properties

NameTypeRequiredRestrictionsDescription
messagestringtruenoneThe message response contains ‘message’ field only

UserRemoveGroupRequestBody

group_id: 4
group_name: owners
user_email: owners
user_id: 1

Properties

NameTypeRequiredRestrictionsDescription
group_idinteger(int64)falsenoneGroupID
group_namestringfalsenoneGroup Name
user_emailstringfalsenoneUserEmail
user_idinteger(int64)falsenoneUser ID

UserRemoveGroupResponseBody

{}

Properties

None

UserRemoveRoleRequestBody

role_id: 4
role_name: owners
user_email: owners
user_id: 1
user_name: owners

Properties

NameTypeRequiredRestrictionsDescription
role_idinteger(int64)falsenoneRoleID
role_namestringfalsenoneRoleName
user_emailstringfalsenoneUser Email
user_idinteger(int64)falsenoneUser ID
user_namestringfalsenoneUser Name

UserRemoveRoleResponseBody

{}

Properties

None

UserSessionResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

NameTypeRequiredRestrictionsDescription
tokenstringfalsenoneToken identifying current session

UserUpdateRequestBody

roles:
  - 0
state: string

Properties

NameTypeRequiredRestrictionsDescription
roles[integer]falsenonenone
statestringfalsenonenone

UserUpdateResponseBody

created_at: 0
email: string
id: 0
password: string
role: 0
role_name: string
state: string
updated_at: 0

Properties

NameTypeRequiredRestrictionsDescription
created_atinteger(int64)falsenonenone
emailstringfalsenonenone
idinteger(int64)falsenonenone
passwordstringfalsenonenone
roleinteger(int64)falsenonenone
role_namestringfalsenonenone
statestringfalsenonenone
updated_atinteger(int64)falsenonenone

Join Waitlist

Join the AI for Life Sciences Challenge

Let's talk