Create AskAI
You can create an AskAI via API, then add content to it and then starting querying it.
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.
Account API Key
Name of the AskAI
Should your AskAI capture a user's email?
Should your AskAI capture a user's name?
Should your AskAI force capture a user's email?
Show suggested starter questions?
Chat system prompt for the AskAI
Explanation system prompt for the AskAI
Type of assistant, must be either; 'Chat - Short and conversational', 'Explain - More detailed answers' or 'Search - Just show the results'
Webhook URL
Webhook authorization key
URL of the AskAI logo
Text for the 'answer not known' response
Chat welcome message
Message ending text e.g. 'Check out these links'
Input/question/search placeholder text
Text for email capture reason
Is custom styling enabled?
Background styling color
Primary text color
User chat text color
User chat message color
Assistant chat text color
Assistant message text color
Primary font
Secondary font
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"
}Successful operation
{
"status": "text",
"response": {
"id": "text",
"api_key": "text",
"embed_id": "text"
}
}Last updated