Create AskAI

You can create an AskAI via API, then add content to it and then starting querying it.

Please email us at [e-mail] from the email associated with your account for your account_api_key.

Your AskAI's id, api_key and embed_id are returned when an AskAI is created. These can be used in subsequent API requests, like adding content and asking questions.

The embed_id is used when adding an AskAI to your website, used within the <script> tag.

Create a new AskAI

POSThttps://myaskai.com/api/1.1/wf/create-askai

Body

application/json

account_api_key*string

Account API Key

name*string

Name of the AskAI

capture_emailboolean

Should your AskAI capture a user's email?

capture_nameboolean

Should your AskAI capture a user's name?

force_capture_emailboolean

Should your AskAI force capture a user's email?

suggested_questionsboolean

Show suggested starter questions?

chat_systemstring

Chat system prompt for the AskAI

explain_systemstring

Explanation system prompt for the AskAI

assistant_typestring

Type of assistant, must be either; 'Chat - Short and conversational', 'Explain - More detailed answers' or 'Search - Just show the results'

webhookstring

Webhook URL

webhook_authstring

Webhook authorization key

logostring

URL of the AskAI logo

text_IDKstring

Text for the 'answer not known' response

text_chat_welcomestring

Chat welcome message

text_message_endingstring

Message ending text e.g. 'Check out these links'

text_input_placeholderstring

Input/question/search placeholder text

text_email_capture_reasonstring

Text for email capture reason

custom_stylingboolean

Is custom styling enabled?

styling_backgroundstring

Background styling color

styling_primary_text_colorstring

Primary text color

styling_user_chat_text_colorstring

User chat text color

styling_user_chat_message_colorstring

User chat message color

styling_assistant_chat_text_colorstring

Assistant chat text color

styling_assistant_message_text_colorstring

Assistant message text color

styling_primary_fontstring

Primary font

styling_secondary_fontstring

Secondary font

Response

200

Successful operation

Body

application/json

statusstring

Status of the operation

responseobject

Request

JavaScriptCurl

const response = await fetch('https://myaskai.com/api/1.1/wf/create-askai', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account_api_key": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "status": "text",
  "response": {
    "id": "text",
    "api_key": "text",
    "embed_id": "text"
  }
}