Query API

Use the Query API to create an integratation with your AI chatbot.

With our API you can build your own internal tools or workflows and harness the power of your AI chatbot wherever you want, however you want.

The API is powerful, but very simple. You input a question and get an answer back, along with the references/content used in the answer.

See full details of the API below. Alternatively, you can use our pre-built integrations with Slack, Microsoft Teams or Zapier.

Ask a question to AskAI

POSThttps://myaskai.com/api/1.1/wf/ask-ai-query

Body

application/json

id*string

AskAI ID

api_key*string

AskAI API Key

query*string

Question to AskAI

Response

200

Successful response

Body

application/json

answerstring

Answer from AskAI

referencesarray of object

suggestedQuestionsarray of string

Array of suggested follow-up questions

unknown_answerenum

Indicates if the answer is known or not

noyes

Request

JavaScriptCurl

const response = await fetch('https://myaskai.com/api/1.1/wf/ask-ai-query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "api_key": "text",
      "query": "text"
    }),
});
const data = await response.json();

Response

{
  "answer": "text",
  "references": [
    {
      "content": "text",
      "link": "https://example.com",
      "score": 0,
      "title": "text"
    }
  ],
  "suggestedQuestions": [
    "text"
  ],
  "unknown_answer": "no"
}

If your AskAI doesn't know the answer, the API will return a field to confirm an answer wasn't found:"unknown_answer": "yes"

The query field has a 750 character limit. If this is exceeded, you will see an error: {"error":"This question is too long. Please ensure questions are less than 750 characters."}