v1

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

List datasets

Lists datasets containing answers and corresponding questions. You can choose to list only your own datasets, as well as template datasets, or both. You might need to iterate over multiple pages to obtain all of your datasets.

get/api/v1/datasets

Query parameters

listMode'LIST_MODE_UNDEFINED' | 'ALL' | 'ONLY_TEMPLATE' | 'ONLY_USER'

The list mode indicating to query public datasets, only user datasets or both.

  • LIST_MODE_UNDEFINED: The list dataset mode type undefined.
  • ALL: List all datasets.
  • ONLY_TEMPLATE: List the template datasets. 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.
  • ONLY_USER: List the user datasets.
limitinteger

The limit defining the maximal number of datasets to return.

cursorstring

The cursor to view the next paginated collection of datasets as provided by the next_cursor value in the ListDatasetsResponse.

Response

A successful response.

limitinteger

The effective limit of the maximum number of datasets that could be returned by the list endpoint. If the limit defined in ListDatasetsRequest was not set, this value indicates the used limit.

nextCursorstring

The cursor that can be used to query the next paginated collection of results.

Example response

{
  "datasets": [
    {
      "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"
    }
  ],
  "limit": 20,
  "nextCursor": "VGhpcyBpcyBub3QgYSByZWFsIGN1cnNvciwgYnV0IHRoZXkgd291bGQgYmUgYmFzZTY0IGVuY29kZWQgdG9vCg=="
}
All 4 operations