CBK.AI
CBK.AI DOCS
ChatBotKit
GitHub Repo
GitHub Org
Preparing search index...
The search index is not available
ChatBotKit Node SDK
ChatBotKit Node SDK
@chatbotkit/sdk
bot/v1
downvoteBot
Function downvoteBot
downvote
Bot
(
client
,
botId
,
request
)
:
Promise
<
BotDownvoteResponse
>
Parameters
client
:
ChatBotKitClient
botId
:
string
request
:
BotDownvoteRequest
Returns
Promise
<
BotDownvoteResponse
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
ChatBotKit Node SDK
@chatbotkit/fetch
FetchError
FetchFn
withRetryOptions
withTimeoutOptions
jsonl
withRetry
withTimeout
@chatbotkit/sdk
blueprint
BlueprintClient
ResponsePromise
blueprint/v1
BlueprintCloneResponse
BlueprintCreateRequest
BlueprintCreateResponse
BlueprintDeleteResponse
BlueprintFetchResponse
BlueprintInstance
BlueprintListRequest
BlueprintListResponse
BlueprintListStreamItemType
BlueprintListStreamType
BlueprintOptions
BlueprintUpdateRequest
BlueprintUpdateResponse
ChatBotKitClient
ResponsePromise
cloneBlueprint
createBlueprint
deleteBlueprint
fetchBlueprint
listBlueprints
updateBlueprint
bot
BotClient
ResponsePromise
bot/session
BotSessionClient
bot/session/v1
BotSessionCreateRequest
BotSessionCreateResponse
ChatBotKitClient
createBotSession
bot/v1
BotCreateRequest
BotCreateResponse
BotDeleteResponse
BotDownvoteRequest
BotDownvoteResponse
BotFetchResponse
BotInstance
BotListRequest
BotListResponse
BotListStreamItemType
BotListStreamType
BotOptions
BotUpdateRequest
BotUpdateResponse
BotUpvoteRequest
BotUpvoteResponse
ChatBotKitClient
ResponsePromise
createBot
deleteBot
downvoteBot
fetchBot
listBots
updateBot
upvoteBot
buffer
getBuffer
client
ChatBotKitClient
ResponsePromise
ChatBotKitClientOptions
contact
ContactClient
ResponsePromise
contact/v1
ChatBotKitClient
ContactCreateRequest
ContactCreateResponse
ContactDeleteResponse
ContactFetchResponse
ContactInstance
ContactListRequest
ContactListResponse
ContactListStreamItemType
ContactListStreamType
ContactOptions
ContactUpdateRequest
ContactUpdateResponse
ResponsePromise
createContact
deleteContact
fetchContact
listContacts
updateContact
conversation
ConversationClient
ResponsePromise
conversation/attachment
ConversationAttachmentClient
ResponsePromise
conversation/attachment/v1
ChatBotKitClient
ConversationAttachmentUploadRequest
ConversationAttachmentUploadResponse
ResponsePromise
uploadConversationAttachment
conversation/message
ConversationMessageClient
ResponsePromise
conversation/message/v1
ChatBotKitClient
ConversationMessageCreateRequest
ConversationMessageCreateResponse
ConversationMessageDeleteResponse
ConversationMessageDownvoteRequest
ConversationMessageDownvoteResponse
ConversationMessageFetchResponse
ConversationMessageInstance
ConversationMessageListRequest
ConversationMessageListResponse
ConversationMessageListStreamItem
ConversationMessageListStreamType
ConversationMessageOptions
ConversationMessageType
ConversationMessageUpdateRequest
ConversationMessageUpdateResponse
ConversationMessageUpvoteRequest
ConversationMessageUpvoteResponse
ResponsePromise
createConversationMessage
deleteConversationMessage
downvoteConversationMessage
fetchConversationMessage
listConversationMessages
updateConversationMessage
upvoteConversationMessage
conversation/session
ConversationSessionClient
conversation/session/v1
ChatBotKitClient
ConversationSessionCreateRequest
ConversationSessionCreateResponse
createConversationSession
conversation/v1
ChatBotKitClient
ConversationCompleteMessage
ConversationCompleteMessageRequest
ConversationCompleteMessageResponse
ConversationCompleteMessageStreamMessage
ConversationCompleteMessageStreamResult
ConversationCompleteMessageStreamToken
ConversationCompleteMessageStreamType
ConversationCompleteRequest
ConversationCompleteResponse
ConversationCompleteStreamResult
ConversationCompleteStreamToken
ConversationCompleteStreamType
ConversationCreateRequest
ConversationCreateResponse
ConversationDeleteResponse
ConversationDownvoteRequest
ConversationDownvoteResponse
ConversationFetchResponse
ConversationInstance
ConversationListRequest
ConversationListResponse
ConversationListStreamItem
ConversationListStreamType
ConversationOptions
ConversationReceiveMessageRequest
ConversationReceiveMessageResponse
ConversationReceiveMessageStreamMessage
ConversationReceiveMessageStreamResult
ConversationReceiveMessageStreamToken
ConversationReceiveMessageStreamType
ConversationSendMessageRequest
ConversationSendMessageResponse
ConversationSendMessageStreamResult
ConversationSendMessageStreamType
ConversationUpdateRequest
ConversationUpdateResponse
ConversationUpvoteRequest
ConversationUpvoteResponse
Entity
Message
MessageType
ResponsePromise
completeConversation
completeConversationMessage
createConversation
deleteConversation
downvoteConversation
fetchConversation
listConversations
receiveConversationMessage
sendConversationMessage
updateConversation
upvoteConversation
dataset
DatasetClient
ResponsePromise
dataset/file
DatasetFileClient
ResponsePromise
dataset/file/v1
ChatBotKitClient
DatasetFileAttachRequest
DatasetFileAttachResponse
DatasetFileDetachRequest
DatasetFileDetachResponse
DatasetFileInstance
DatasetFileListRequest
DatasetFileListResponse
DatasetFileListStreamItemType
DatasetFileListStreamType
DatasetFileSyncRequest
DatasetFileSyncResponse
ResponsePromise
attachDatasetFile
detachDatasetFile
listDatasetFiles
syncDatasetFile
dataset/record
DatasetRecordClient
ResponsePromise
dataset/record/v1
ChatBotKitClient
DatasetRecordCreateRequest
DatasetRecordCreateResponse
DatasetRecordDeleteResponse
DatasetRecordFetchResponse
DatasetRecordInstance
DatasetRecordListRequest
DatasetRecordListResponse
DatasetRecordListStreamItem
DatasetRecordListStreamType
DatasetRecordOptions
DatasetRecordUpdateRequest
DatasetRecordUpdateResponse
ResponsePromise
createDatasetRecord
deleteDatasetRecord
fetchDatasetRecord
listDatasetRecords
updateDatasetRecord
dataset/v1
ChatBotKitClient
DatasetCreateRequest
DatasetCreateResponse
DatasetDeleteResponse
DatasetFetchResponse
DatasetInstance
DatasetListRequest
DatasetListResponse
DatasetListStreamItemType
DatasetListStreamType
DatasetOptions
DatasetSearchResponse
DatasetUpdateRequest
DatasetUpdateResponse
ResponsePromise
createDataset
deleteDataset
fetchDataset
listDatasets
searchDataset
updateDataset
file
FileClient
ResponsePromise
file/v1
FileInstance
ChatBotKitClient
FileCreateRequest
FileCreateResponse
FileDeleteResponse
FileDownloadResponse
FileFetchResponse
FileListRequest
FileListResponse
FileListStreamItemType
FileListStreamType
FileOptions
FileUpdateRequest
FileUpdateResponse
FileUploadRequest
FileUploadResponse
ResponsePromise
createFile
deleteFile
downloadFile
fetchFile
listFiles
updateFile
uploadFile
integration/discord
DiscordIntegrationClient
ResponsePromise
integration/discord/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
DiscordIntegrationCreateRequest
DiscordIntegrationCreateResponse
DiscordIntegrationDeleteResponse
DiscordIntegrationFetchResponse
DiscordIntegrationInstance
DiscordIntegrationListRequest
DiscordIntegrationListResponse
DiscordIntegrationListStreamItem
DiscordIntegrationListStreamType
DiscordIntegrationOptions
DiscordIntegrationSetupResponse
DiscordIntegrationUpdateRequest
DiscordIntegrationUpdateResponse
ResponsePromise
createDiscordIntegration
deleteDiscordIntegration
fetchDiscordIntegration
listDiscordIntegrations
setupDiscordIntegration
updateDiscordIntegration
integration/email
EmailIntegrationClient
ResponsePromise
integration/email/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
EmailIntegrationCreateRequest
EmailIntegrationCreateResponse
EmailIntegrationDeleteResponse
EmailIntegrationFetchResponse
EmailIntegrationInstance
EmailIntegrationListRequest
EmailIntegrationListResponse
EmailIntegrationListStreamItem
EmailIntegrationListStreamType
EmailIntegrationOptions
EmailIntegrationSetupResponse
EmailIntegrationUpdateRequest
EmailIntegrationUpdateResponse
ResponsePromise
createEmailIntegration
deleteEmailIntegration
fetchEmailIntegration
listEmailIntegrations
setupEmailIntegration
updateEmailIntegration
integration/extract
ExtractIntegrationClient
ResponsePromise
integration/extract/v1
ChatBotKitClient
ExtractInegrationInstance
ExtractIntegrationCreateRequest
ExtractIntegrationCreateResponse
ExtractIntegrationDeleteResponse
ExtractIntegrationFetchResponse
ExtractIntegrationListRequest
ExtractIntegrationListResponse
ExtractIntegrationListStreamItem
ExtractIntegrationListStreamType
ExtractIntegrationOptions
ExtractIntegrationUpdateRequest
ExtractIntegrationUpdateResponse
ResponsePromise
createExtractIntegration
deleteExtractIntegration
fetchExtractIntegration
listExtractIntegrations
updateExtractIntegration
integration/messenger
MessengerIntegrationClient
ResponsePromise
integration/messenger/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
MessengerIntegrationCreateRequest
MessengerIntegrationCreateResponse
MessengerIntegrationDeleteResponse
MessengerIntegrationFetchResponse
MessengerIntegrationInstance
MessengerIntegrationListRequest
MessengerIntegrationListResponse
MessengerIntegrationListStreamItem
MessengerIntegrationListStreamType
MessengerIntegrationOptions
MessengerIntegrationSetupResponse
MessengerIntegrationUpdateRequest
MessengerIntegrationUpdateResponse
ResponsePromise
createMessengerIntegration
deleteMessengerIntegration
fetchMessengerIntegration
listMessengerIntegrations
setupMessengerIntegration
updateMessengerIntegration
integration/notion
NotionIntegrationClient
ResponsePromise
integration/notion/v1
ChatBotKitClient
NotionInegrationInstance
NotionIntegrationCreateRequest
NotionIntegrationCreateResponse
NotionIntegrationDeleteResponse
NotionIntegrationFetchResponse
NotionIntegrationListRequest
NotionIntegrationListResponse
NotionIntegrationListStreamItem
NotionIntegrationListStreamType
NotionIntegrationOptions
NotionIntegrationSyncResponse
NotionIntegrationUpdateRequest
NotionIntegrationUpdateResponse
ResponsePromise
createNotionIntegration
deleteNotionIntegration
fetchNotionIntegration
listNotionIntegrations
syncNotionIntegration
updateNotionIntegration
integration/sitemap
SitemapIntegrationClient
ResponsePromise
integration/sitemap/v1
ChatBotKitClient
ResponsePromise
SitemapInegrationInstance
SitemapIntegrationCreateRequest
SitemapIntegrationCreateResponse
SitemapIntegrationDeleteResponse
SitemapIntegrationFetchResponse
SitemapIntegrationListRequest
SitemapIntegrationListResponse
SitemapIntegrationListStreamItem
SitemapIntegrationListStreamType
SitemapIntegrationOptions
SitemapIntegrationSyncResponse
SitemapIntegrationUpdateRequest
SitemapIntegrationUpdateResponse
createSitemapIntegration
deleteSitemapIntegration
fetchSitemapIntegration
listSitemapIntegrations
syncSitemapIntegration
updateSitemapIntegration
integration/slack
SlackIntegrationClient
ResponsePromise
integration/slack/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
ResponsePromise
SlackIntegrationCreateRequest
SlackIntegrationCreateResponse
SlackIntegrationDeleteResponse
SlackIntegrationFetchResponse
SlackIntegrationInstance
SlackIntegrationListRequest
SlackIntegrationListResponse
SlackIntegrationListStreamItem
SlackIntegrationListStreamType
SlackIntegrationOptions
SlackIntegrationSetupResponse
SlackIntegrationUpdateRequest
SlackIntegrationUpdateResponse
createSlackIntegration
deleteSlackIntegration
fetchSlackIntegration
listSlackIntegrations
setupSlackIntegration
updateSlackIntegration
integration/support
SupportIntegrationClient
ResponsePromise
integration/support/v1
ChatBotKitClient
ResponsePromise
SupportInegrationInstance
SupportIntegrationCreateRequest
SupportIntegrationCreateResponse
SupportIntegrationDeleteResponse
SupportIntegrationFetchResponse
SupportIntegrationListRequest
SupportIntegrationListResponse
SupportIntegrationListStreamItem
SupportIntegrationListStreamType
SupportIntegrationOptions
SupportIntegrationUpdateRequest
SupportIntegrationUpdateResponse
createSupportIntegration
deleteSupportIntegration
fetchSupportIntegration
listSupportIntegrations
updateSupportIntegration
integration/telegram
TelegramIntegrationClient
ResponsePromise
integration/telegram/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
ResponsePromise
TelegramIntegrationCreateRequest
TelegramIntegrationCreateResponse
TelegramIntegrationDeleteResponse
TelegramIntegrationFetchResponse
TelegramIntegrationInstance
TelegramIntegrationListRequest
TelegramIntegrationListResponse
TelegramIntegrationListStreamItem
TelegramIntegrationListStreamType
TelegramIntegrationOptions
TelegramIntegrationSetupResponse
TelegramIntegrationUpdateRequest
TelegramIntegrationUpdateResponse
createTelegramIntegration
deleteTelegramIntegration
fetchTelegramIntegration
listTelegramIntegrations
setupTelegramIntegration
updateTelegramIntegration
integration/trigger
TriggerIntegrationClient
ResponsePromise
integration/trigger/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
ResponsePromise
TriggerIntegrationCreateRequest
TriggerIntegrationCreateResponse
TriggerIntegrationDeleteResponse
TriggerIntegrationFetchResponse
TriggerIntegrationInstance
TriggerIntegrationInvokeRequest
TriggerIntegrationInvokeResponse
TriggerIntegrationListRequest
TriggerIntegrationListResponse
TriggerIntegrationListStreamItem
TriggerIntegrationListStreamType
TriggerIntegrationOptions
TriggerIntegrationSetupResponse
TriggerIntegrationUpdateRequest
TriggerIntegrationUpdateResponse
createTriggerIntegration
deleteTriggerIntegration
fetchTriggerIntegration
invokeTriggerIntegration
listTriggerIntegrations
setupTriggerIntegration
updateTriggerIntegration
integration/whatsapp
WhatsAppIntegrationClient
ResponsePromise
integration/whatsapp/v1
BotConfig
BotRef
BotRefOrConfig
ChatBotKitClient
ResponsePromise
WhatsAppIntegrationCreateRequest
WhatsAppIntegrationCreateResponse
WhatsAppIntegrationDeleteResponse
WhatsAppIntegrationFetchResponse
WhatsAppIntegrationInstance
WhatsAppIntegrationListRequest
WhatsAppIntegrationListResponse
WhatsAppIntegrationListStreamItem
WhatsAppIntegrationListStreamType
WhatsAppIntegrationOptions
WhatsAppIntegrationSetupResponse
WhatsAppIntegrationUpdateRequest
WhatsAppIntegrationUpdateResponse
createWhatsAppIntegration
deleteWhatsAppIntegration
fetchWhatsAppIntegration
listWhatsAppIntegrations
setupWhatsAppIntegration
updateWhatsAppIntegration
integration/widget
WidgetIntegrationClient
ResponsePromise
integration/widget/v1
ChatBotKitClient
ResponsePromise
WidgetInegrationInstance
WidgetIntegrationCreateRequest
WidgetIntegrationCreateResponse
WidgetIntegrationDeleteResponse
WidgetIntegrationFetchResponse
WidgetIntegrationListRequest
WidgetIntegrationListResponse
WidgetIntegrationListStreamItem
WidgetIntegrationListStreamType
WidgetIntegrationOptions
WidgetIntegrationUpdateRequest
WidgetIntegrationUpdateResponse
createWidgetIntegration
deleteWidgetIntegration
fetchWidgetIntegration
listWidgetIntegrations
updateWidgetIntegration
magic
MagicClient
ResponsePromise
magic/v1
ChatBotKitClient
MagicGenerateRequest
MagicGenerateResponse
MagicGenerateStreamResult
MagicGenerateStreamType
ResponsePromise
generateMagic
model/v1
Model
ModelConfig
buildModelString
param
buildParamString
partner
PartnerClient
partner/user
PartnerUserClient
ResponsePromise
partner/user/token
PartnerUserTokenClient
ResponsePromise
partner/user/token/v1
ChatBotKitClient
PartnerUserTokenCreateRequest
PartnerUserTokenCreateResponse
PartnerUserTokenDeleteResponse
PartnerUserTokenInstance
PartnerUserTokenListRequest
PartnerUserTokenListResponse
PartnerUserTokenListStreamItem
PartnerUserTokenListStreamType
PartnerUserTokenOptions
ResponsePromise
createPartnerUserToken
deletePartnerUserToken
listPartnerUserTokens
partner/user/v1
ChatBotKitClient
PartnerUserCreateRequest
PartnerUserCreateResponse
PartnerUserDeleteResponse
PartnerUserFetchResponse
PartnerUserInstance
PartnerUserListRequest
PartnerUserListResponse
PartnerUserListStreamItem
PartnerUserListStreamType
PartnerUserOptions
PartnerUserUpdateRequest
PartnerUserUpdateResponse
ResponsePromise
createPartnerUser
deletePartnerUser
fetchPartnerUser
listPartnerUsers
updatePartnerUser
platform
PlatformClient
platform/ability
PlatformAbilityClient
ResponsePromise
platform/ability/v1
ChatBotKitClient
PlatformAbilityInstance
PlatformAbilityListRequest
PlatformAbilityListResponse
PlatformAbilityListStreamItemType
PlatformAbilityListStreamType
PlatformAbilityOptions
ResponsePromise
listPlatformAbilities
platform/model
PlatformModelClient
ResponsePromise
platform/model/v1
ChatBotKitClient
PlatformModelInstance
PlatformModelListRequest
PlatformModelListResponse
PlatformModelListStreamItemType
PlatformModelListStreamType
PlatformModelOptions
ResponsePromise
listPlatformModels
platform/secret
PlatformSecretClient
ResponsePromise
platform/secret/v1
ChatBotKitClient
PlatformSecretInstance
PlatformSecretListRequest
PlatformSecretListResponse
PlatformSecretListStreamItemType
PlatformSecretListStreamType
PlatformSecretOptions
ResponsePromise
listPlatformSecrets
secret
SecretClient
ResponsePromise
secret/v1
ChatBotKitClient
ResponsePromise
SecretCreateRequest
SecretCreateResponse
SecretDeleteResponse
SecretFetchResponse
SecretInstance
SecretListRequest
SecretListResponse
SecretListStreamItemType
SecretListStreamType
SecretOptions
SecretUpdateRequest
SecretUpdateResponse
createSecret
deleteSecret
fetchSecret
listSecrets
updateSecret
skillset
SkillsetClient
ResponsePromise
skillset/ability
SkillsetAbilityClient
ResponsePromise
skillset/ability/v1
ChatBotKitClient
ResponsePromise
SkillsetAbilityCreateRequest
SkillsetAbilityCreateResponse
SkillsetAbilityDeleteResponse
SkillsetAbilityFetchResponse
SkillsetAbilityInstance
SkillsetAbilityListRequest
SkillsetAbilityListResponse
SkillsetAbilityListStreamItem
SkillsetAbilityListStreamType
SkillsetAbilityOptions
SkillsetAbilityUpdateRequest
SkillsetAbilityUpdateResponse
createSkillsetAbility
deleteSkillsetAbility
fetchSkillsetAbility
listSkillsetAbilities
updateSkillsetAbility
skillset/v1
ChatBotKitClient
ResponsePromise
SkillsetCreateRequest
SkillsetCreateResponse
SkillsetDeleteResponse
SkillsetFetchResponse
SkillsetInstance
SkillsetListRequest
SkillsetListResponse
SkillsetListStreamItemType
SkillsetListStreamType
SkillsetOptions
SkillsetUpdateRequest
SkillsetUpdateResponse
createSkillset
deleteSkillset
fetchSkillset
listSkillsets
updateSkillset
usage/series/v1
ChatBotKitClient
UsageSeriesFetchResponse
UsageSeriesInstance
UsageSeriesOptions
fetchUsageSeries
usage/v1
ChatBotKitClient
UsageFetchResponse
UsageInstance
UsageOptions
fetchUsage
@chatbotkit/react
actions/complete
BasicParametersSchema
HandlerArgs
HandlerOptions
HandlerResult
InputFunction
InputMessage
Item
Message
OnFinishHandler
OnItemHandler
Options
OutputMessage
ReactElement
RenderFunction
ValidatingParametersSchema
default
streamComplete
components/AutoScroller
AutoScroller
components/AutoTextarea
AutoTextarea
default
components/ChatInput
ChatInput
components/ChatMessage
ChatMessage
components/ChatMessages
ChatMessages
components/ConversationManager
ConversationManager
hooks/useConversationManager
ComplexMessage
SimpleMessage
UseConversationManagerOptions
UseConversationManagerRemoteOptions
UseConversationManagerResult
useConversationManager
hooks/useConversationManagerRemote
UseConversationManagerRemoteOptions
EndpointFunction
EndpointURL
UseConversationManagerRemoteResult
useConversationManagerRemote
hooks/useConversationManagerState
State
StateFunctions
useConversationManagerState
hooks/useConversationManagerStateReducer
State
Action
AppendMessageAction
AppendTextAction
Message
SetThinkingAction
SetTypingAction
conversationManagerStateInitial
conversationManagerStateReducer
useConversationManagerStateReducer
hooks/useDOMQuerySelector
useDOMQuerySelector
hooks/useWidgetInstance
ChatBotKitWidgetInstance
WidgetFunction
WidgetFunctionBase
WidgetFunctionWithHandler
WidgetFunctionWithResult
WidgetMessage
WidgetNotification
WidgetSendMessageFn
WidgteRestartConversationFn
useWidgetInstance
hooks/useWidgetInstanceFunctions
WidgetFunction
useWidgetInstanceFunctions
hooks/useWidgetInstanceNotifications
WidgetNotification
useWidgetInstanceNotifications
hooks/useWidgetQuerySelector
ChatBotKitWidgetInstance
useWidgetQuerySelector
utils/stream
ConsumeOptions
ConsumeResult
ConsumeSource
Handlers
StreamOptions
StreamResult
StreamSource
@chatbotkit/next
edge
IterableObject
stream
@chatbotkit/nextauth
adapter
MemoryStore
Store
ChatBotKitPartnerAdapter
provider
ChatBotKitEmailProvider
@chatbotkit/cli
env
getRUNAS_USERID
getSECRET
index
default
input
confirm
prompt
solution
BotResource
DatasetResource
Resource
SitemapIntegrationResource
SkillsetResource
Solution
WidgetIntegrationResource
ResourceConfig
SolutionConfig
BasicResourceConfigSchema
BotResourceConfigSchema
DatasetResourceConfigSchema
ResourceConfigSchema
SitemapIntegrationResourceConfigSchema
SkillsetResourceConfigSchema
SolutionConfigSchema
WidgetIntegrationResourceConfigSchema
getArrayBackedObject
Generated using
TypeDoc