Dataset Records

List Dataset Records

Retrieve a list of dataset records

get
/v1/dataset/{datasetId}/record/list

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

datasetIdstring* Required

The ID of the dataset

cursorstring

The cursor to use for pagination

orderstring

The order of the paginated items

takeinteger

The number of items to retrieve

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.dataset.record.list(

datasetId
)
{
"items":[
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"text":"string",
"source":"string"
}
]
}
The list of records was retrieved successfully