Web canvas

Kapso Documentation

Build, test, deploy, and manage WhatsApp AI Agents.

Introduction

Create and deploy your first WhatsApp AI Agent using Kapso

Run your first agent

Learn how to test your WhatsApp AI Agents to ensure reliability.

Run your first test

Test your AI Agent in WhatsApp using the Kapso sandbox

Try in WhatsApp

Automate internal ops

Build your core product

White-label product

Why graphs

Understanding the building blocks of agent graphs

Nodes and edges

Connecting nodes and defining conversational paths

Edges

Kapso CLI and Cursor

Test Suites and Cases

Use the Kapso WhatsApp Sandbox to test your agents in a real WhatsApp environment

WhatsApp Sandbox

API & Webhooks

Get started with the Kapso Command Line Interface

Installation

Authenticate with your Kapso account via the CLI

Login

kapso init

Deploy your agent and tests to the Kapso platform

kapso deploy

Pull agent definition and tests from server

kapso pull

kapso create agent

kapso run

Create a new test suite for your Kapso agent

kapso create test-suite

Create a new test case for testing your Kapso agent

kapso create test-case

kapso test

Create a WhatsApp sandbox session for testing

kapso create sandbox-session

Visualize agent knowledge graph as an image

kapso visualize

kapso help

kapso logout

Kapso API Reference

Returns a list of all agents for the authenticated project

List all agents

Creates a new agent with default graph structure

Create a new agent

Get agent details

Update an agent

Returns agent details including the langgraph definition

Get agent with graph

Returns all test suites associated with the specified agent

List test suites for an agent

Returns a list of executions for the specified agent

List agent executions

Triggers a new execution of the specified agent

Start a new agent execution

Returns details for a specific agent execution

Get agent execution details

Resumes an execution that was previously paused

Resume a paused agent execution

Create a new test suite

Returns details for a specific test suite including all test cases

Get test suite with test cases

Creates a new test case for a specific test suite

Create a new test case

Get test case details

Update a test case

Creates a new test run for a specific test case

Create a new test run

Get test run details

Get project details

Returns a list of WhatsApp sandbox sessions for the project associated with the API key

List sandbox sessions

Creates a new WhatsApp sandbox session for the project associated with the API key

Create a sandbox session

Returns details for a specific WhatsApp sandbox session

Get sandbox session details

List WhatsApp conversations

Returns details for a specific WhatsApp conversation

Get WhatsApp conversation details

Updates the status of a specific WhatsApp conversation

Update WhatsApp conversation status

Returns a list of messages for a specific WhatsApp conversation

List messages in a WhatsApp conversation

Sends a new message through WhatsApp Cloud API and creates the message record

Send a new WhatsApp message

Returns all agent executions associated with a specific WhatsApp conversation

List agent executions for a WhatsApp conversation

Returns details for a specific agent execution association

Get agent execution association details

Returns a list of customers for the project

List customers

Create a new customer

Get customer details

Delete customer

Update customer

Returns a list of WhatsApp configurations for a specific customer

List WhatsApp configs for a customer

Creates a new WhatsApp configuration for a specific customer

Create a new WhatsApp config

Returns details for a specific WhatsApp configuration

Get WhatsApp config details

Delete WhatsApp config

Updates a WhatsApp configuration's details

Update WhatsApp config

Initiates a test conversation with the specified agent

Start a new agent test chat

Returns details for a specific agent test chat

Get agent test chat details

Returns a list of assignments for a specific WhatsApp conversation

List conversation assignments

Creates a new assignment for a WhatsApp conversation

Create a conversation assignment

Updates an existing conversation assignment (e.g., notes, user, active status)

Update a conversation assignment

Returns a list of WhatsApp templates available for the project

List WhatsApp templates

Returns details for a specific WhatsApp template

Get WhatsApp template details

Sends a WhatsApp template message to a specified phone number

Send a WhatsApp template message

Creates a snapshot of an agent at its current state, or with a provided graph structure

Quickstart

Use cases

Build agents

Test agents

Integrations

Web canvas