Sending a question (realtime)

post

https://rest-endpoint.unless.com/api/v1/ai/query

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The query endpoint always gives you a chat-data object that has the original question and the response it generated. Normally, you would use this object to show the response in your view. It's important to use the chatDataJson property when you ask any more questions to make sure the conversation history is kept correctly

Body Params

query

string

required

The question you want to send to the AI.

accountId

string

required

Your account ID. See: https://unless.com/en/dashboard/account/settings

apiKey

string

required

Your API key. See: https://unless.com/en/dashboard/account/settings

websiteId

string

required

The website ID you trained the AI on.

visitorId

string

required

An unique identifier for your visitor.

sessionId

string

required

An unique identifier for the current session.

conversationName (optional)

string

In case you have multiple topics, you can give each a different name.

segmentId (optional)

string

Optional segment to search in

audienceId (optional)

string

You can provide an audienceId to be used for content lookup. Use comma-separated id's to supply multiple.

metadata (optional)

json

Send an additional metadata object that we'll show in the dashboard.

messageFormat (optional)

string

enum

Defaults to md

You can set this value to 'html' if you want the messages formatted as html instead of markdown

Allowed:

skipLanguageDetection (optional)

boolean

Defaults to false

The AI will validate if the question asked is in the same language as the current conversation language. If that doesn't match, the AI will send back a command to switch the conversation language. You can turn off this language check using this property, which means the AI will always respond in the conversation language.

chatDataJson

string

required

Our chat-data wrapper for managing history. See the response at the right for an example. To maintain a proper history, which is important for follow-up questions and logging, you should supply this with every query (except the first query).

Headers

x-api-key

string

required

Your API key from account settings

Responses

200200

400400