Sign in

v1

latestSwagger 2.0raw.githubusercontent.com2022-07-0141021.9 KB
FAQ

Get dataset

Retrieves the dataset for the given dataset ID.

get/api/v1/datasets/{datasetId}

Path parameters

datasetIdstring required

The unique ID for the dataset.

Response

A successful response.

datasetIdstring uuid

The unique ID for the dataset.

namestring

The name of the dataset.

createdAtstring timestamp

The timestamp of dataset creation. Uses the ISO-8601 standard.

updatedAtstring timestamp

The timestamp of last update. Uses the ISO-8601 standard.

isTemplateboolean

Whether this dataset is a template dataset or not. Template datasets are used as examples and can be found under the Templates tab in the dataset overview of the dashboard. You can clone such datasets to kickstart the creation of a dataset that is tailored to your use-case.

descriptionstring

The optional description of the dataset.

lastTrainedAtstring timestamp

The timestamp of last model that completed training. Uses the ISO-8601 standard.

Example response

{
  "createdAt": "2021-08-24T12:04:32Z",
  "datasetId": "dde4eeae-7652-4bc8-8be1-1cd6ac898dc7",
  "description": "This dataset has a list of frequently asked questions about MessageBird",
  "isTemplate": false,
  "lastTrainedAt": "2021-08-24T12:04:32Z",
  "name": "MessageBird FAQ",
  "updatedAt": "2021-08-24T12:04:32Z"
}