Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatbase Chatbots API

Create, retrain, configure, list, and delete chatbots/agents.

Chatbase Chatbots API is one of 5 APIs that Chatbase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chatbots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 5 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://www.chatbase.co/api/v1.

5 operations 5 paths 6 schemas 1 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://www.chatbase.co/api/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Chatbase Chatbots API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer API key created in the Chatbase dashboard (Workspace Settings - API Keys).

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Chatbots 5

Create, retrain, configure, list, and delete chatbots/agents.

POST
/create-chatbot
Create a chatbot
createChatbot body → 200400401
POST
/update-chatbot-data
Update and retrain a chatbot
updateChatbotData body → 200400401
POST
/update-chatbot-settings
Update chatbot settings
updateChatbotSettings body → 200400401
GET
/get-chatbots
List chatbots
getChatbots → 200401
DELETE
/delete-chatbot
Delete a chatbot
deleteChatbot body → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are UpdateChatbotSettingsRequest (6 properties), Chatbot (5 properties), UpdateChatbotDataRequest (3 properties), CreateChatbotRequest (3 properties). Each schema is shown below with its type and property counts.

CreateChatbotRequest
object
3 properties 2 required
UpdateChatbotDataRequest
object
3 properties 1 required
Status
object
2 properties
Error
object
2 properties
Chatbot
object
5 properties
UpdateChatbotSettingsRequest
object
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatbase-chatbots-api-openapi.yml Raw ↑

Other APIs Chatbase publishes across the network.

Chatbase Chat API
Chatbase Contacts API
Chatbase Conversations API
Chatbase Leads API