Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Query

Request parameters

Response

Chatling Documentation

Documentation

API Reference

Dashboard

Get a list of all the members in the project.

List members

Welcome to Chatling, the platform for building AI-powered chatbots.

Getting started

Learn about the Builder and how to create conversational flows for your chatbot.

Overview

Chatbot Builder

Learn about the canvas and how to navigate and interact with it.

Canvas

Learn about the Sidebar and its functionalities in the Builder.

Sidebar

Block Editor

Blocks are the core components of every chatbot. Learn how to use them to build your chatbot's conversational flow.

Blocks

Quick Replies

Allow users to speak to your chatbot using Voice Input.

Voice Input

Learn about Variables, the different types, and how to use them

What are variables?

There are two types of variables: System Variable and Custom Variable. Learn how to use them in your chatbot.

Types of variables

Learn how to create variables in the Builder

How to create variables

A guide on how to use Variables in your chatbot

How to use variables

Learn how to test your chatbot to see how it works.

Test your chatbot

Learn how to save your changes in the Builder.

Save your work

Learn how to publish your chatbot and make it live.

Publish your chatbot

Learn about intents and how they work in Chatling

Introduction

A guide on how to create and manage your chatbot's intents

Manage intents

Learn how to use intents to create more complex chatbot flows

Using intents

Learn about the Knowledge Base and how it works.

What is the Knowledge Base?

Learn about the different types of data sources you can add to the Knowledge Base.

Types of data sources

A guide on adding data sources to the Knowledge Base.

Add data source

Learn how to exclude certain sections of a webpage when adding a data source.

Exclude webpage sections

Learn how to re-sync data sources in the Knowledge Base.

Re-sync data sources

Learn how to delete data sources in the Knowledge Base.

Delete data sources

A list of supported AI models in Chatling.

Supported AI Models

A guide on what AI Instructions are and how to use them.

Instructions

Learn how to set the LLM model used by the AI.

Setting the AI model

Learn how to enable sources for AI responses.

Displaying sources

A guide on how to manage team members in your project.

Learn how to invite team members to your project and assign them different roles.

Roles

Roles & Permissions

Learn about the different roles and permissions that can be assigned to team members in a project.

Invite

Invite Team Members

Learn how to remove team members from your project.

Remove

Remove Team Members

Learn how to duplicate a chatbot to create a copy of it.

Duplicate

How to duplicate a chatbot

A guide on how to make your chatbot public or private.

Visibility

Schedule the chatbot to be visible at certain times.

Operating hours

A guide on how to set up and display satisfaction surveys.

Satisfaction survey

A guide on how to share your chatbot with others.

Share

Learn how to remove a chatbot permanently from your account.

Delete

How to delete a chatbot

Learn how to add Chatling to your website.

Learn how to add Chatling to your website

Custom Website

Learn how to add Chatling to your WordPress website

WordPress

Learn how to add Chatling to your website using Google Tag Manager

Google Tag Manager

Learn how to add Chatling to your Shopify store

Shopify

Learn how to add Chatling to your Squarespace website

Squarespace

Learn how to add Chatling to your Wix website

Learn how to add Chatling to your Webflow website

Webflow

Learn how to add Chatling to your Bubble website

Bubble

Learn how to add Chatling to your PrestaShop website

PrestaShop

A guide on how to customize the appearance of your chatbot widget and make it match your brand.

Customization

Design your chatbot widget

Language

Set the language of your chatbot widget

Learn how to send any data, such as customer information, to the chatbot widget.

Pass custom data to the widget

How to pass custom data to your chatbot

Available SDK methods

Learn how to collect and save leads using your chatbot.

How to capture leads

How to capture and store leads

Learn how to set the visibility of your chatbot on specific pages.

How to hide the chatbot on specific pages

Understanding AI credits and how they are consumed

What are AI credits?

How many AI credits are consumed by each model?

How to reset the chat on page load?

Got other questions?

The Chatling API allows you to manage your chatbots programmatically.

API Introduction

Our API has rate limits to prevent abuse and ensure fair usage.

Rate limiting

List settings

Update settings

Get a list of all the available chatbot templates. Can be used to create a new chatbot.

List chatbot templates

Create a new chatbot using a template or from scratch.

Create chatbot

Get a list of all the chatbots in the project.

List chatbots

Retrieve chatbot

Update chatbot settings

Get a list of all the supported AI models.

List AI models

Get a list of all the supported AI languages.

List AI languages

Chat with the AI using the knowledge base as the response source.

Chat

Chat with Knowledge Base AI

Get a list of all the contacts and leads saved by the chatbot.

List contacts

Retrieve contact

Delete contact

Get a list of all the chatbot's conversations with users.

List conversations

Retrieve conversation

Update conversation

Get a list of all the messages for a conversation

List conversation messages

Get a list of the data sources added to the knowledge base.

List data sources

Add new link data sources to the knowledge base.

Add link

Add new text data sources to the knowledge base.

Add text

Add new FAQ data sources to the knowledge base.

Add FAQ

Resync data source

Delete a data source from the knowledge base.

Delete data source

Get the AI credits usage for the project.

AI Credits

Get the email credits usage for the project.

Email Credits

Get the knowledge base usage for the project.

Knowledge Base

Chatbots

Get the user seats usage for the project.

Project

Members

Chatbots

AI

Contacts

Conversations

Knowledge base

Usage

List members

Request parameters

Query

Response

Project

Members

Chatbots

AI

Contacts

Conversations

Knowledge base

Usage

​Request parameters

​Query

​Response

Request parameters

Query

Response