Dataset Files

Detach Dataset File

Detach dataset file

post
/v1/dataset/{datasetId}/file/{fileId}/detach

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

datasetIdstring* Required

The ID of the dataset

fileIdstring* Required

The ID of the file

Request Body * Required

Request Body Schema: application/json

deleteRecordsboolean

Delete records associated with the file

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.dataset.file.detach(

datasetId, fileId,
{
"deleteRecords":"boolean"
}
)
{
"id":"string"
}
The dataset file that was detached successfully