Platforms

Search Platform Content Manuals

Search platform manuals using semantic similarity

post
/v1/platform/content/manual/search

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

searchstring

The search query to find relevant manuals

takeinteger

The maximum number of results to return (1-100, default 10)

import { ChatBotKit } from '@chatbotkit/sdk'


const cbk = new ChatBotKit({
secret: process.env.CHATBOTKIT_API_KEY!
})


const response = await cbk.platform.content.manual.search(
{
"search":"string",
"take":"integer"
}
)
{
"items":[
{
"name":"string",
"description":"string",
"meta":"object",
"id":"string",
"createdAt":"number",
"updatedAt":"number",
"category":"string",
"tags":[
"string"
],
"index":"number",
"score":"number",
"excerpt":"string",
"url":"string"
}
]
}
The search was successful
Go to cbk.ai