My AskAI Docs
  • Welcome
    • 👋Welcome to My AskAI
  • START HERE
    • 🤷‍♂️What is an AI chatbot?
      • How Should I Use it?
      • Where Can I Use it?
      • Will it Make Things Up?
      • How Much Content Do I Need?
      • What Is It Good/Bad At?
      • What If It Can't Answer?
    • 🏗️Build Your AI Chatbot
      • Create Your 1st AI (Chat)
      • Create Your 1st AI (Explain)
      • Create Your 1st AI (Summarize)
      • Create Your 1st AI (Search)
      • How Long Does it Take?
    • 🗃️What is Content?
    • 📼101 Video Tutorial
    • 🤔How Does it Work?
    • ⭐Reviews
    • 🆘Support
  • SECURITY + PRIVACY
    • 🔐Security
      • On-Premise
      • Set a Password For Your AskAI
      • Lock to a Domain
      • OpenAI API Keys
      • SOC-2
    • 👣Privacy
      • Your AI chatbot
      • Your Content
      • Your Data
      • OpenAI
      • Regulations
        • GDPR Compliance
        • HIPAA
  • Features
    • ❓Questions, Answers + References
      • Change the Answer "Style" (Length, Format etc)
      • Editing Suggested (Starter) Questions
      • Auto-Generated Follow-up Questions On/Off
      • Edit Follow Up Questions
      • Turn Follow Up Questions On/Off (Explain)
      • Show Source Reference Text (Explain)
      • Turn References On/Off (Chat)
      • Citation References (Chat)
      • Meta Data and References
      • 'Corrections'
        • How To Correct An "I don't know" Response
        • How To Correct An Answer
    • 🤏Summarize
    • 🗄️Adding Content
      • ☁️Content Upload & Sync Integrations
        • 🔁Connect & Sync Google Drive
        • 🔁Connect & Sync Notion
      • Automatic Content Updates
      • Upload a CSV File to Your AskAI
      • Add an Entire Website (or Sitemap)
      • Deleting or Removing Content
      • Bulk Upload a List of Files or Links
    • 🔗Integrations + Embed
      • Website
      • Slack
      • Microsoft Teams
      • WhatsApp
      • Wordpress
      • Zapier
      • Bubble
      • Add To...
        • ✈️Add to Telegram
        • 🔳Add to Squarespace
        • 🧙Add to Wix
        • 🛒Add to Shopify
        • ♦️Add to Carrd
        • 🟨Add to Zoho
        • 🚀Add to Kajabi
    • 🎨Customization
      • How It Talks
        • Customize Tone and Voice ("System Prompt")
        • Customize Your Welcome Message
        • Add a Custom Ending Message
        • Edit Your "I don't know" Response
      • How It Looks
        • Edit Starter and Follow-up Question Titles
        • Change Your Image, Name and Description
        • Personalize the Appearance of Your AskAI
        • Edit Placeholder Text (Explain)
    • 💪Power Features
      • ⚡Supercharged Answers (GPT-4)
      • 📧Email Capture
      • 🗣️Name Capture
      • 📊Analytics
        • Get your Insights Report
        • Download Question and Answer History
        • Download Questions That Couldn't Be Answered
      • 🌐Custom Domains
      • ◻️Removing Branding
    • 🤝Sharing
    • 🖱️Modes
      • Change the Mode of Your AskAI
      • Search with AskAI
  • Tutorials
    • ✅Improving Answers
    • ⬜Uploading tabular data
    • 🌎Localize Your AskAI
      • Supported Languages
    • 🔌Build a ChatGPT Plugin
    • 📺YouTube Tutorials
  • Use Cases
    • 🗣️Customer Support
    • 🧠Knowledge Sharing
    • ✍️Research
    • 📣Content Marketing
    • 👩‍🏫Teaching
    • 🚢Onboarding
  • TROUBLESHOOTING
    • 👺Integration issues
    • 🐢Slow Responses
    • 💬Chat Bubble Not Visible
    • 🤷‍♀️Why can't it answer?
    • ⬆️File Upload Issues
    • 🤓CSV Upload Issues
    • 🗝️Login
    • 😕No Content Appearing
  • API Documentation
    • API Docs
    • Ask Questions, Chat, Search
      • Query (Explain)
      • Chat
      • Search
    • Manage Content
      • Add Content
      • Update Content
      • Delete Content
      • Retrieve Specific Content
      • Search All Content
    • Create & Manage AskAIs
      • Create AskAI
      • Update AskAI
      • Delete AskAI
      • Get AskAI Details
    • Python Library
  • ACCOUNT MANAGEMENT
    • 💲Pricing + Plans
    • 🧱Limits
      • Exceeding Limits
      • Questions
    • 🦸‍♀️Your Profile
      • Changing Your Email
      • Delete an AskAI
      • Close Your Account
    • 💳Your Subscription
      • Update Payment Card
      • Download an Invoice
      • Discounts
      • Refunds
      • Tax
      • Downgrade Plan
      • Cancel Subscription
    • 🧑‍🤝‍🧑User Access
      • Transfering Data
      • Restricting Access
      • Multi-user Access
      • Setting a Password for Your Account
      • Reset Login Password
    • 🤑Affiliate Program
    • 💼Reselling + Whitelabelling
  • FAQ
    • 🪖General
      • 💡Feature Suggestions
      • 📞Human Handover
      • 🎏Answer Streaming
      • 🌡️Temperature
      • 💇‍♂️My AskAI vs Fine-tuning
      • 🤖My AskAI vs ChatGPT
      • 📚(Large Language Models) LLMs
      • 🔗Prompt Chaining
      • ⚖️What is the difference between My AskAI and My AskAI Classic?
Powered by GitBook
On this page
  1. API Documentation
  2. Create & Manage AskAIs

Create AskAI

PreviousCreate & Manage AskAIsNextUpdate AskAI

Last updated 1 year ago

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