Dataset

Create

Used to create dataset.

POST URL:{{base_url}}/api/{{version}}/dataset/create

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	Application/jsonn

Request Body

Name	Type	Description
file*	form-data	Zip file.
name*	form-data	Name of the dataset.
task_type*	form-data	Type of dataset.
description*	form-data	Description of the dataset.

200: OK Created dataset.

{
    "data": {
        "dataset_id": "String"
    },
    "message": "created successfully",
    "status": 200
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

500: Internal Server Error

{
    // Response
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

View

Used to list datasets.

GET URL:{{base_url}}/api/{{version}}/dataset/view

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	Application/jsonn

200: OK Returns details of all datasets.

{
    "data": {
        "datasets": "List of datasets"
    },
    "message": "string",
    "status": 200
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

500: Internal Server Error

{
    // Response
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

View

Used to get details of a particular dataset.

GET URL:{{base_url}}/api/{{version}}/dataset/:id/view

Path Parameters

Name	Type	Description
id	String	Id of a particular dataset.

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	Application/jsonn

200: OK Returns details of a particular dataset.

{
    "data": {
        "dataset_details": "dict"
    },
    "message": "string",
    "status": 200
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

401: Unauthorized

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

500: Internal Server Error

{
    // Response
}

Upload

Used to upload data item for upgrading dataset.

POST URL:{{base_url}}/api/{{version}}/dataset/:id/upload

Path Parameters

Name	Type	Description
id*	String	Id of the dataset.

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	application/json

Request Body

Name	Type	Description
file	form-data	In the case of FORM and DOC models, file must be a document with extension png, jpeg and pdf. In the case of NER model, file must be a json.
label_file	form-data	Json file. Used in FORM and DOC models.
ocr_file	form-data	Json file. Used in FORM and DOC models.
fields_json	form-data	Json file. Used in FORM models.

200: OK Uploaded data item to the server.

{
    "data": {},
    "message": "data uploaded to storage folder",
    "status": 200
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

500: Internal Server Error

{
    // Response
}

Upload API is used to upload single data item at a time.

Update

Used to update dataset using uploaded data.

POST URL:{{base_url}}/api/{{version}}/dataset/:id/upload

Path Parameters

Name	Type	Description
id*	String	Id of the dataset.

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	application/json

200: OK Updated dataset using uploaded data. Dataset is ready for upgrade.

{
    "data": {
        "dataset_id": "string"
    },
    "message": "dataset updated successfully!!!ready for upgrade",
    "status": 200
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

500: Internal Server Error

{
    // Response
}

Bulk Update

Used to update dataset using zip file which contains multiple data items.

POST URL:{{base_url}}/api/{{version}}/dataset/:id/bulkupdate

Path Parameters

Name	Type	Description
id*	String	Id of dataset.

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	application/json

200: OK Updated dataset using zip file.

{
    "data": {
        "dataset_id": "string"
    },
    "message": "uploaded zip file to staging folder.dataset is ready for upgrade",
    "status": 200
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

500: Internal Server Error

{
    // Response
}

Used to upload and update multiple data items.

Upgrade

Used to upgrade dataset which is already updated.

POST URL:{{base_url}}/api/{{version}}/model/:id/dataset/upgrade

Path Parameters

Name	Type	Description
id *	String	Id of dataset.

Headers

Name	Type	Description
Authorization*	API key
Content-Type*	application/json

200: OK Dataset is upgraded.

{
    "data": {
        "dataset_id": "string"
    },
    "message": "successfully upgraded",
    "status": 200
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

401: Unauthorized Invalid API key.

{
    "data": {},
    "message": "ERROR: Unauthorized",
    "status": 401
}

500: Internal Server Error

{
    // Response
}