Request Parameters
URL Identifier
To obtain your collection's
url_identifier
go to API Keys.
Request Parameters
Each API request (e.g., Create Chat
, Send Message
) accepts a standard JSON body with the following parameters:
Parameter
Required
Type
Description
message
Yes
string
The query or prompt you are sending to the knowledge base. This represents the user's question.
modelProvider
Optional
string
The specific LLM to use for the response. If not specified, the system defaults to llama-3-8b
. See supported models here
markdown
Optional
boolean
If true
, the response will be returned in Markdown format (e.g., for rendering rich responses in a UI). Defaults to false
.
Examples
Basic usage
{
"message": "What is this collection about?"
}
Full usage
{
"message": "Summarize the first document",
"modelProvider": "llama-4-17b",
"markdown": true
}
Last updated