Datasets

Datasets

Get all datasets

Returns all the existing datasets in a client.

URL

GET https://tools.deepen.ai/api/v2/clients/{clientId}/datasets

Request

Path parameters

Parameter name	Parameter type	Description
clientId	string	Client Id obtained from Deepen AI

Response

Returns a json with each field representing a dataset Id and its corresponding value being a DatasetResource.

Get all datasetIds

Returns all the existing datasetIds in a client.

URL GET https://tools.deepen.ai/api/v2/clients/{clientId}/datasets_ids

Request

Path parameters

Parameter name	Parameter type	Description
clientId	string	Client Id obtained from Deepen AI

Response

Returns a json with key “datasets” and value as a list of dataset details object.

Dataset details object has field names ‘dataset_id’ and ‘dataset_name’ with corresponding values.

Response Object:

{“datasets”:

[

{“dataset_id”: “testdatasetId1”, “dataset_name”:”testdatasetname1”},

{“dataset_id”: “testdatasetId1”, “dataset_name”:”testdatasetname1”}

]

}

Get dataset

Get the metadata related to a dataset.

URL

GET https://tools.deepen.ai/api/v2/datasets/{datasetId}

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the dataset

**Note: To get the dataset details of old format datasets (created using v1 APIs) using this api please pass the dataset_id as client_id:project_id:dataset_id

Response

Returns a DatasetResource object.

Files

Get all files

Returns all the files in a dataset.

URL

GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/files

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the dataset

Response

Returns a json with field ‘files’ that represents an array of FileResource objects.

Get file

Get the metadata related to a file.

URL

GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/files/{fileId}

Request

Path parameters

Parameter name	Parameter type	Description
datasetId	string	Dataset Id of the file
fileId	string	File Id of the file

Response

Returns a FileResource object.