Create AskAI

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

Please contact us via chat 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

post

Body

account_api_keystringRequired

Account API Key

namestringRequired

Name of the AskAI

capture_emailbooleanOptional

Should your AskAI capture a user's email?

capture_namebooleanOptional

Should your AskAI capture a user's name?

force_capture_emailbooleanOptional

Should your AskAI force capture a user's email?

suggested_questionsbooleanOptional

Show suggested starter questions?

chat_systemstringOptional

Chat system prompt for the AskAI

explain_systemstringOptional

Explanation system prompt for the AskAI

assistant_typestringOptional

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

webhookstringOptional

Webhook URL

webhook_authstringOptional

Webhook authorization key

logostringOptional

URL of the AskAI logo

text_IDKstringOptional

Text for the 'answer not known' response

text_chat_welcomestringOptional

Chat welcome message

text_message_endingstringOptional

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

text_input_placeholderstringOptional

Input/question/search placeholder text

text_email_capture_reasonstringOptional

Text for email capture reason

custom_stylingbooleanOptional

Is custom styling enabled?

styling_backgroundstringOptional

Background styling color

styling_primary_text_colorstringOptional

Primary text color

styling_user_chat_text_colorstringOptional

User chat text color

styling_user_chat_message_colorstringOptional

User chat message color

styling_assistant_chat_text_colorstringOptional

Assistant chat text color

styling_assistant_message_text_colorstringOptional

Assistant message text color

styling_primary_fontstringOptional

Primary font

styling_secondary_fontstringOptional

Secondary font

Responses

200

Successful operation

application/json

post

HTTPcURLJavaScriptPython

POST /api/1.1/wf/create-askai HTTP/1.1
Host: myaskai.com
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "account_api_key": "text",
  "name": "text",
  "capture_email": true,
  "capture_name": true,
  "force_capture_email": true,
  "suggested_questions": true,
  "chat_system": "text",
  "explain_system": "text",
  "assistant_type": "text",
  "webhook": "text",
  "webhook_auth": "text",
  "logo": "text",
  "text_IDK": "text",
  "text_chat_welcome": "text",
  "text_message_ending": "text",
  "text_input_placeholder": "text",
  "text_email_capture_reason": "text",
  "custom_styling": true,
  "styling_background": "text",
  "styling_primary_text_color": "text",
  "styling_user_chat_text_color": "text",
  "styling_user_chat_message_color": "text",
  "styling_assistant_chat_text_color": "text",
  "styling_assistant_message_text_color": "text",
  "styling_primary_font": "text",
  "styling_secondary_font": "text"
}

200

Successful operation

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