Skip to main content
POST
/
v1
/
chatbot
Start a new conversation
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/chatbot \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "assistantId": "<string>",
  "userIdentifier": "<string>",
  "question": "<string>",
  "attributes": {
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>"
  }
}
'
{
"response": "Response generated by LLM",
"conversationId": "A newly created conversationId to identify the conversation."
}

​
Authorizations

​
x-api-key
string
required
API key associated with your workspace

​
Body Parameters

​
workspaceId
string
required
A unique identifier (UUID) that specifies the workspace within which the assistant operates.
​
assistantId
string
required
A unique identifier (UUID) that specifies the assistant to be used for generating the LLM response.
​
userIdentifier
string
required
A unique identifier associated with the user or customer initiating the conversation. This identifier is crucial for tracking and storing individual conversation histories. It allows you to maintain context across multiple interactions with the same user. Example: “user12345” or “customer_email@example.com”
​
question
string
required
The user’s query or prompt that is submitted to the LLM. The LLM will use this question to generate a relevant response.
​
attributes
object
The attributes parameter is an optional JSON object that allows you to provide additional contextual information or metadata with your API request. This can be used for various purposes, you can use this to pass user or customer details like firstName, lastName, or any other relevant information to personalize the interaction.

​
Response

​
response
string
The response generated by the LLM.
​
conversationId
string
The ID associated with the conversation.
{
"response": "Response generated by LLM",
"conversationId": "A newly created conversationId to identify the conversation."
}