API v1 Reference

Chatbots API (v1)

API v1 reference for creating and managing AI chatbot agents programmatically.

Overview

The Chatbots API v1 lets you manage your AI agents programmatically. Each workspace has one chatbot — create it, update its configuration, manage publishing, and control access keys.

Get Chatbot

GET /workspaces/{workspaceId}/chatbot — Retrieve the chatbot configuration for a workspace. Returns the full configuration including name, system prompt, model settings, theme, feature toggles, and current version info.

Create Chatbot

POST /workspaces/{workspaceId}/chatbot — Create a new chatbot in a workspace (one per workspace). Body includes: name, description, system prompt, model configuration, and optional theme settings. Four built-in workflows (main, error, timeout, conversation_end) are automatically initialized.

Update Chatbot

PUT /workspaces/{workspaceId}/chatbot — Update chatbot configuration. You can modify: name, avatar, welcome message, system prompt, personality mode (professional, friendly, casual, custom), model selection, temperature, max tokens, theme (colors, fonts, border radius, styles), and feature toggles (feedback, file upload, sounds, sources, typing indicator).

Publish Chatbot

POST /workspaces/{workspaceId}/chatbot/publish — Publish the current draft as a new version. All workflows are validated before publishing. The response includes the new version number. Use GET /versions to list all published versions and POST /versions/{versionNumber}/restore to rollback.