​

Introduction

This is documentation for version 2.0 of the LiveChatAI REST API.

• All changes to version 2.0 can be viewed in the Changelog.
• To change your version, see our versioning page.

This version of our API reference is auto-generated from an OpenAPI specification. It is also interactive, which means you can now make calls to the LiveChatAI API directly from the docs, using Node, Ruby, PHP, Java, Python, and other languages.

If you’d like to chat with other LiveChatAI customers who are integrating with our API, you can ask a question in the LiveChatAI Community.

For more information about LiveChatAI products, you can visit our product documentation.

​

API Overview

The LiveChatAI API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

​

Base URL

All API requests should be made to:

https://app.livechatai.com/api/v2/

​

Authentication

The LiveChatAI API uses API keys to authenticate requests. You can view and manage your API keys in the LiveChatAI Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so on.

Authentication to the API is performed via HTTP Bearer Authentication. Provide your API key as the bearer token value:

curl https://app.livechatai.com/api/v2/chatbots \
  -H "Authorization: Bearer YOUR_API_KEY"

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

​

Response Format

All responses are returned in JSON format with the following structure:

{
  "status": "success",
  "data": {
    // Response data
  }
}

Error responses follow this format:

{
  "status": "error",
  "message": "Error description",
  "code": "error_code"
}

​

HTTP Status Codes

LiveChatAI uses conventional HTTP response codes to indicate the success or failure of an API request:

• 200 - OK: Everything worked as expected
• 400 - Bad Request: The request was unacceptable
• 401 - Unauthorized: No valid API key provided
• 403 - Forbidden: The API key doesn’t have the required permissions
• 404 - Not Found: The requested resource doesn’t exist
• 429 - Too Many Requests: Too many requests hit the API too quickly
• 500 - Server Error: Something went wrong on our end

​

API Reference

• Chatbots - Create and manage AI chatbots
• Conversations - Handle chat conversations and messages
• Contacts - Manage visitor contacts and their data
• Data Sources - Train your chatbot with knowledge base content
• Messages - Send and receive messages

​

Support

If you need help with the API or have questions:

• Email: support@livechatai.com
• Discord: Join our community
• Documentation: help.livechatai.com