Chatbase

Chatbase is a custom AI chatbot and AI agent platform for customer support. Teams train an agent on their own content (websites, files, Q&A), embed it on their site, and connect it to channels and tools. The Chatbase REST API lets developers message agents (with streaming), create and update chatbots/agents, retrieve conversations and leads, and manage contacts.

5 APIs 0 Features

AIChatbotAI AgentCustomer SupportConversational AI

APIs

Chatbase Chat API

Send a message to a Chatbase agent and receive a response. Accepts a messages array with user and assistant roles, supports continuing an existing conversation, temperature cont...

Chatbase Chatbots and Agents API

Programmatically create chatbots/agents from training text, retrain and rename them, update settings, list all agents on the account, delete an agent, and manage agent icons and...

Chatbase Conversations API

Retrieve a paginated history of conversations for a specific chatbot, filterable by date range and source, with full message transcripts.

Chatbase Sources and Data API

Update and retrain an agent with new training content, and manage contacts and their custom-attribute schema for a chatbot (create, list, get, update, and delete contacts and cu...

Chatbase Leads API

Retrieve leads collected by a chatbot's lead-capture form for a specific chatbot, returning name, email, phone, and submission metadata.

Collections

Chatbase API

OPEN

Pricing Plans

Chatbase Plans Pricing

6 plans

PLANS

Rate Limits

Chatbase Rate Limits

4 limits

RATE LIMITS

FinOps

Chatbase Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Chatbase API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Chat
    type: folder
  items:
  - info:
      name: Message an agent
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/chat
      body:
        type: json
        data: "{\n  \"messages\": [ { \"role\": \"user\", \"content\": \"<string>\" } ],\n  \"chatbotId\": \"<string>\",\n\
          \  \"stream\": false\n}"
    docs: Send a message to a chatbot and receive a response. Set stream=true to receive the reply word by word as raw text.
- info:
    name: Chatbots
    type: folder
  items:
  - info:
      name: Create a chatbot
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/create-chatbot
      body:
        type: json
        data: "{\n  \"chatbotName\": \"<string>\",\n  \"sourceText\": \"<string>\"\n}"
    docs: Create a new chatbot/agent and train it from the supplied sources.
  - info:
      name: Update and retrain a chatbot
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/update-chatbot-data
      body:
        type: json
        data: "{\n  \"chatbotId\": \"<string>\",\n  \"chatbotName\": \"<string>\",\n  \"sourceText\": \"<string>\"\n}"
    docs: Update a chatbot, changing its name and/or replacing its training material.
  - info:
      name: Update chatbot settings
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/update-chatbot-settings
      body:
        type: json
        data: "{\n  \"chatbotId\": \"<string>\"\n}"
    docs: Update configuration settings for an existing chatbot.
  - info:
      name: List chatbots
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/get-chatbots
    docs: Retrieve all chatbots for the authenticated account.
  - info:
      name: Delete a chatbot
      type: http
    http:
      method: DELETE
      url: https://www.chatbase.co/api/v1/delete-chatbot
      body:
        type: json
        data: "{\n  \"chatbotId\": \"<string>\"\n}"
    docs: Permanently delete a chatbot and all of its associated data.
- info:
    name: Conversations
    type: folder
  items:
  - info:
      name: Get conversations
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/get-conversations?chatbotId=<string>&startDate=2023-01-01&endDate=2023-12-12&page=1&size=20
    docs: Retrieve conversations for a specific chatbot, optionally filtered by date range and source, with pagination.
- info:
    name: Leads
    type: folder
  items:
  - info:
      name: Get leads
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/get-leads?chatbotId=<string>&page=1&size=20
    docs: Retrieve leads captured by a specific chatbot's lead form.
- info:
    name: Contacts
    type: folder
  items:
  - info:
      name: Create contacts
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts
      body:
        type: json
        data: "{\n  \"contacts\": [ { \"name\": \"<string>\", \"email\": \"<string>\" } ]\n}"
    docs: Create one or more contacts for a chatbot (up to 1000 per request).
  - info:
      name: List contacts
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts?limit=20
    docs: Retrieve a paginated list of contacts for a chatbot.
  - info:
      name: Get a contact
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts/{contactId}
    docs: Retrieve a single contact by ID.
  - info:
      name: Update a contact
      type: http
    http:
      method: PATCH
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts/{contactId}
      body:
        type: json
        data: "{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\"\n}"
    docs: Update an existing contact's information.
  - info:
      name: Delete a contact
      type: http
    http:
      method: DELETE
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts/{contactId}
    docs: Permanently delete a contact.
  - info:
      name: Create a custom attribute
      type: http
    http:
      method: POST
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/custom-attributes
      body:
        type: json
        data: "{\n  \"name\": \"<string>\",\n  \"type\": \"text\"\n}"
    docs: Define a new custom attribute on the contact schema for a chatbot.
  - info:
      name: Get the custom-attribute schema
      type: http
    http:
      method: GET
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/custom-attributes
    docs: Retrieve the custom-attribute schema for contacts.
  - info:
      name: Update a custom attribute
      type: http
    http:
      method: PUT
      url: https://www.chatbase.co/api/v1/chatbots/{chatbotId}/custom-attributes/{name}
      body:
        type: json
        data: "{\n  \"name\": \"<string>\",\n  \"type\": \"text\"\n}"
    docs: Update an existing custom attribute.