Developer API

13references · REST API for building integrations

Everything you need to integrate Sarufi chatbots into your applications via REST API.

Introduction

Getting Started

Build chatbots, manage flows, and connect channels with the Sarufi REST API.

View reference
Introduction

Authentication

Authenticate API requests using your workspace Bearer token.

View reference
Resources

Workspace

Verify your API key and retrieve workspace information.

View reference
Resources

Chatbots

Create, list, retrieve, update, and delete chatbots in your workspace.

View reference
Resources

Flows

Create and manage conversation flows and meta flows for a chatbot.

View reference
Resources

Conversations

List and inspect conversations and messages for a chatbot.

View reference
Resources

Chat

Create chat sessions and send messages to interact with published chatbot flows via API.

View reference
Resources

Integrations

Connect chatbots to WhatsApp, REST API, web widget channels, and external MCP tool servers.

View reference
Resources

Knowledge Bases

Create and manage knowledge bases, add sources, and connect them to chatbots.

View reference
Resources

Analytics

Retrieve conversation and message metrics for a chatbot.

View reference
Resources

MCP Server Integration

Register remote MCP servers as LLM agent tools via the Model Context Protocol.

View reference
Guides

How Flows Work

Understand the flow system — states, transitions, variables, and action types — and how the conversation engine uses them to drive a chat.

View reference
Guides

Connecting to Your Backend

Use the API_CALL action to fetch data, submit forms, and trigger operations in your own systems from inside a conversation flow.

View reference