Query (Explain)

Query API Request and Response

Our Query API allows a user to ask questions to your AskAI via a simple API call.

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

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"
    }
  ]
}

If your AskAI doesn't know the answer, the API will also return an additional field to confirm an answer wasn't found as well as 3 suggested questions the user can retry (these have a very high likelihood of being answered correctly):

"unknown_answer": "yes",

"suggestedQuestions": ["Example question", ...]

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