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

API Docs

Getting started with our API is quick and easy. You can create and manage your AskAIs and your content, as well as asking questions or 'chatting' with you content.

  • API access is only for paid accounts

  • API access is enabled by default for paid accounts

  • Most API requests require an AskAI ID and API Key, these can be from the Settings page within your AskAI

  • Authentication and access is managed per AskAI, not across your entire account

  • Authentication is handled via the API's request body, not via any headers

  • Remember to set the header for Content-Type: application/json

  • All API requests are POST methods

  • The answers you get via API should be identical to those you would receive if you were interacting directly through the UI

PreviousNo Content AppearingNextAsk Questions, Chat, Search

Last updated 1 year ago