FluxbaseAI

Fluxbase AI client for listing chatbots and managing conversations

Example

const ai = new FluxbaseAI(fetchClient, 'ws://localhost:8080')

// List available chatbots
const { data, error } = await ai.listChatbots()

// Create a chat connection
const chat = ai.createChat({
  token: 'my-jwt-token',
  onContent: (delta) => process.stdout.write(delta),
})

await chat.connect()
const convId = await chat.startChat('sql-assistant')
chat.sendMessage(convId, 'Show me recent orders')

Constructors

new FluxbaseAI()

new FluxbaseAI(fetch, wsBaseUrl): FluxbaseAI

Parameters

Parameter	Type
fetch	object
fetch.delete	(path) => Promise<void>
fetch.get	<T>(path) => Promise<T>
fetch.patch	<T>(path, body?) => Promise<T>
wsBaseUrl	string

Returns

FluxbaseAI

Methods

createChat()

createChat(options): FluxbaseAIChat

Create a new AI chat connection

Parameters

Parameter	Type	Description
options	Omit<AIChatOptions, "wsUrl">	Chat connection options

Returns

FluxbaseAIChat

FluxbaseAIChat instance

---

deleteConversation()

deleteConversation(id): Promise<object>

Delete a conversation

Parameters

Parameter	Type	Description
id	string	Conversation ID

Returns

Promise<object>

Promise resolving to { error } (null on success)

Name	Type
error	null | Error

Example

const { error } = await ai.deleteConversation('conv-uuid-123')
if (!error) {
  console.log('Conversation deleted')
}

---

getChatbot()

getChatbot(id): Promise<object>

Get details of a specific chatbot

Parameters

Parameter	Type	Description
id	string	Chatbot ID

Returns

Promise<object>

Promise resolving to { data, error } tuple with chatbot details

Name	Type
data	null | AIChatbotSummary
error	null | Error

---

getConversation()

getConversation(id): Promise<object>

Get a single conversation with all messages

Parameters

Parameter	Type	Description
id	string	Conversation ID

Returns

Promise<object>

Promise resolving to { data, error } tuple with conversation detail

Name	Type
data	null | AIUserConversationDetail
error	null | Error

Example

const { data, error } = await ai.getConversation('conv-uuid-123')
if (data) {
  console.log(`Title: ${data.title}`)
  console.log(`Messages: ${data.messages.length}`)
}

---

listChatbots()

listChatbots(): Promise<object>

List available chatbots (public, enabled)

Returns

Promise<object>

Promise resolving to { data, error } tuple with array of chatbot summaries

Name	Type
data	null | AIChatbotSummary[]
error	null | Error

---

listConversations()

listConversations(options?): Promise<object>

List the authenticated user’s conversations

Parameters

Parameter	Type	Description
options?	ListConversationsOptions	Optional filters and pagination

Returns

Promise<object>

Promise resolving to { data, error } tuple with conversations

Name	Type
data	null | ListConversationsResult
error	null | Error

Example

// List all conversations
const { data, error } = await ai.listConversations()

// Filter by chatbot
const { data, error } = await ai.listConversations({ chatbot: 'sql-assistant' })

// With pagination
const { data, error } = await ai.listConversations({ limit: 20, offset: 0 })

---

updateConversation()

updateConversation(id, updates): Promise<object>

Update a conversation (currently supports title update only)

Parameters

Parameter	Type	Description
id	string	Conversation ID
updates	UpdateConversationOptions	Fields to update

Returns

Promise<object>

Promise resolving to { data, error } tuple with updated conversation

Name	Type
data	null | AIUserConversationDetail
error	null | Error

Example

const { data, error } = await ai.updateConversation('conv-uuid-123', {
  title: 'My custom conversation title'
})