Introduction

Welcome to the Quickchat AI API!

It’s a single endpoint that allows you to add conversational AI to your product.

Before you start, head over to the Quickchat AI dashboard to set up your AI’s Knowledge Base, customize your AI Assistant’s Settings and Personality.

Authentication

Include your API key and scenario_id in every request.

In order to obtain your API key, create an account and upgrade your subscription to include API access.

Chat

Initialise new conversation / new user history

curl https://chat.quickchat.ai/chat \
  -H 'Content-Type: application/json' \
  -d '{
  "api_key": "<API_KEY>",
  "scenario_id": "<SCENARIO_ID>",
  "text": "Hello!"
}'

import requests, json
response = requests.post(
  url="https://chat.quickchat.ai/chat",
  json={
    "api_key": "<API_KEY>",
    "scenario_id": "<SCENARIO_ID>",
    "text": "Hello!"
  })
if response.status_code == 200:
  data = json.loads(response.content)
else:
  raise ValueError(
    "Error code {}: {}".format(
      response.status_code, 
      response.content.decode('utf-8')))

The above command returns JSON structured like this:

{
    "ord_number": 2,
    "conv_id": "abcd1234",
    "reply": "Hey there! 🙂"
}

conv_id is an optional parameter. Request which does not contain conv_id starts a new conversation and newly-generated conv_id is returned.

Associate conv_id with your particular user to maintain conversation context across time and multiple user interactions.

This endpoint performs a single conversation exchange.

HTTP Request

POST https://chat.quickchat.ai/chat

Query Parameters

Send message to AI

curl https://chat.quickchat.ai/chat \
  -H 'Content-Type: application/json' \
  -d '{
  "api_key": "<API_KEY>",
  "scenario_id": "<SCENARIO_ID>",
  "conv_id": "abcd1234",
  "text": "Hello!"
}'

import requests, json
response = requests.post(
  url="https://chat.quickchat.ai/chat",
  json={
    "api_key": "<API_KEY>",
    "scenario_id": "<SCENARIO_ID>",
    "conv_id": "abcd1234",
    "text": "Hello!"
  })
if response.status_code == 200:
  data = json.loads(response.content)
else:
  raise ValueError(
    "Error code {}: {}".format(
      response.status_code, 
      response.content.decode('utf-8')))

The above command returns JSON structured like this:

{
    "ord_number": 236,
    "reply": "Hey, great to hear from you again! 😉"
}

Say something to the AI and receive a response.

When conv_id is provided, the corresponding conversation (by a particular user) will be continued. If no matching conversation for given scenario_id and conv_id is found conv_id does not exist error is returned.

HTTP Request

POST https://chat.quickchat.ai/chat

Query Parameters

Errors

The following error codes may be returned by the API: