Platforms
Fetch Platform Guide
Fetch a specific platform guide
get
/v1/platform/guide/{guideId}/fetch
Description
Retrieves the complete content and metadata of a specific guide. This includes the markdown content and all associated frontmatter.
Authorization
ChatBotKit API Secret * Required
HTTP Authorization Scheme: bearer
Path Parameters
guideIdstring* Required
The ID of the guide to fetch
import { ChatBotKit } from '@chatbotkit/sdk'
const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})
const response = await cbk.platform.guide.fetch(
guideId)
{"name":"string","description":"string","meta":"object","id":"string","createdAt":"number","updatedAt":"number","category":"string","tags":["string"],"index":"number","content":"string","link":"string"}The guide was retrieved successfully