Query

Send a query to a chatbot to answer

POST https://api.sitespeak.ai/v1/{chatbot_id}/query

Queries your chatbot and returns the answer and URLs used to find the answer.

Path Parameters

NameTypeDescription

chatbot_id*

String

The ID of your chatbot. You can find the ID on the settings page for your chatbot.

Headers

NameTypeDescription

Authorization*

String

Bearer {api_token}

Body

NameTypeDescription

prompt*

String

The question or query text that you would like to send to your chatbot to answer.

conversation_id

String

A unique identifier to group questions and answers sent to your chatbot.

format

String (markdown or html)

Can be either html or markdown. Defaults to return the response text in markdown.

{
	"text": "The answer to your question...",
	"urls": ["https://example.com/1", "https://example.com/2"]
}

Last updated