Skip to main content
POST
/
chat
cURL
curl --request POST \
  --url https://www.quikquery.io/api/v1/chat \
  --header 'Content-Type: application/json' \
  --header 'api-token: <api-key>' \
  --data '
{
  "botId": "<string>",
  "input": {
    "question": "<string>",
    "history": [
      {
        "human": "<string>",
        "ai": "<string>"
      }
    ]
  },
  "messageId": "<string>",
  "feedbackType": "<string>",
  "helpfulMessage": true
}
'
{
  "answer": "<string>",
  "sources": [
    {
      "content": "<string>",
      "source": "<string>",
      "title": "<string>",
      "similarityScore": 123
    }
  ],
  "options": [
    "<string>"
  ]
}

Authorizations

api-token
string
header
required

Body

application/json

Chat message object containing the user's question and bot information

botId
string
required

The unique identifier of the bot to chat with

input
object
required
messageId
string

Optional unique identifier for the message

feedbackType
string

Feedback type when providing feedback (e.g., 'Yes, this helped me', 'No, I need more help')

helpfulMessage
boolean

Flag to request helpful message options

Response

Successful chat response

answer
string

The AI-generated response to the user's question

sources
object[]

Array of source documents used to generate the response

options
string[]

Array of suggested follow-up options or actions