Platforms

Fetch Platform Tutorial

Fetch a specific platform tutorial

get
/v1/platform/tutorial/{tutorialId}/fetch

Description

Retrieves the complete content and metadata of a specific tutorial. This includes the markdown content and all associated frontmatter.

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

tutorialIdstring* Required

The ID of the tutorial to fetch (e.g., "how-to-get-started-with-chatbotkit")

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.platform.tutorial.fetch(

tutorialId
)
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"category":"string",
"tags":[
"string"
],
"index":"number",
"content":"string",
"link":"string"
}
The tutorial was retrieved successfully