--- title: "Retrieves the list of pre-trained datasets" method: GET path: "/api/list-datasets" tags: ["AI Dataset Management"] --- # Retrieves the list of pre-trained datasets `GET /api/list-datasets` ## Request - Base URL: `https://api.worqhat.com` - URL: `https://api.worqhat.com/api/list-datasets` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint fetches all the datasets that you have trained along with the dataset IDs and the training status. ## Response `200` Successful response - object - `status` string: Status indicating the success of the Audio Conversion Process. - `data` object[] - `dataset_id` string: The ID of the dataset. - `dataset_name` string: The name of the dataset. - `dataset_description` string: The description of the dataset. - `training_for` string: The purpose of the dataset. It is usually either for ``Search Models`` or ``Generative Models``. - `type` string: The type of the dataset when trained. It holds values as ``Self`` for datasets available to the User and ``Org`` for datasets available to the members of the Organization. - `dataset_timestamp` object - `_seconds` integer: The timestamp of the dataset creation in seconds. - `_clock_hash` integer: The clock hash of the dataset. Used for making sure all the Machine Learning are in sync with the dataset. - `processing_time` integer: The time taken to process the request, in milliseconds. - `processing_id` string: A universally unique identifier for the request. This can be used to track the request in the logs. - `processing_count` integer: The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes. ## Other responses - `400`: Bad Request. This mostly happens because of invalid image sizes. Neither `height` nor `width` of the image should be less than 128px. Only one of the sides of the image should be greater than or equal to 512px. (Eg: 512x512, 512x768, 768x512) Maximum dimensions supported is 512x896. - `401`: Unauthorized - `404`: Not Found - `406`: Not Acceptable - `500`: Internal Server Error ## Changes - **2023-10-20** `871850b7231f`: 3 warning, 18 info - removed the optional property `datasets` from the response with the `200` status - removed the optional property `id` from the response with the `200` status - removed the optional property `timestamp` from the response with the `200` status - api operation id `datasetList` removed and replaced with `listDatasets` - …17 more - **2023-08-15** `b5ffe2a9748f`: 5 breaking, 12 info - the response's body type changed from no type to `object` for status `400` - the response's body type changed from no type to `object` for status `401` - the response's body type changed from no type to `object` for status `404` - the response's body type changed from no type to `object` for status `406` - …13 more - **2023-08-04** `be85a8f8fc8c`: 5 breaking, 10 warning - the response's body type changed from `object` to no type for status `400` - the response's body type changed from `object` to no type for status `401` - the response's body type changed from `object` to no type for status `404` - the response's body type changed from `object` to no type for status `406` - …11 more - **2023-08-04** `d6dbf089e00d`: 1 info - the endpoint scheme security `bearerAuth` was removed from the API - **2023-08-03** `87a2697d00bf`: 2 info - the endpoint scheme security `bearerAuth` was added to the API - the endpoint scheme security `ApiKeyAuth AND OrgKeyAuth` was removed from the API [Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/changes/api/list-datasets/get.md) --- [API](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2.md) - [All operations](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/llms.txt) - [OpenAPI document](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/revisions/fc369f69a3e6?raw)