Platforms

List Platform Content Docs

Retrieve a list of platform docs

get
/v1/platform/content/doc/list

Description

Returns a list of available documentation docs with their metadata.

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

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.platform.content.doc.list(

)
{
"items":[
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"category":"string",
"tags":[
"string"
],
"index":"number",
"url":"string"
}
]
}
The list of docs was retrieved successfully