Home Building Flows Flow Testing with Controlled Flow via API

Flow Testing with Controlled Flow via API

Last updated on Aug 26, 2026

Controlled Flow's API allows you to start and continue conversations automatically with created flows through HTTP calls. This feature is ideal for automated testing, interaction validation, and ensuring that flows are functioning as expected.

This guide presents the complete process for using the API.

Integration Overview

Communication with Controlled Flow is conducted in two main steps:

  1. Start the conversation: creates a new chat session.

  2. Continue the conversation: sends messages within the created session.

These calls are made via HTTP endpoints, using an authentication token and the ID of the flow created in Controlled Flow.

Step-by-Step Integration Guide

1. Obtain the flow ID

Each flow created in Controlled Flow has a unique identifier (ID), which is used to initiate the session via API. This ID can be copied directly from the flow editing URL or from the publishing screen.

2. Start a new chat session

Endpoint:

POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/typebots/ID_OF_FLOW/startChat

Required Headers:

  • Content-Type: application/json

  • Authorization: Bearer {{apiToken}}

Expected Response:

{ "sessionId": "abc123xyz"}

This sessionId is essential for the next steps.

3. Send messages to continue the chat

Endpoint:

POST https://eddieeyes.us-east-1.prd.cloudhumans.io/api/v1/sessions/{{sessionId}}/continueChat

Headers:

  • Content-Type: application/json

  • Authorization: Bearer {{apiToken}}

Body:

{ "message": "user message"}

Response: A JSON object with Controlled Flow's next interaction based on the flow logic.

How to generate a token

To authenticate API calls, you need an API Token. Follow the steps below to generate one:

  1. Click on Settings and Members in the top right corner.

  2. In the side menu, select My Account.

  3. In the API tokens section, click Create to generate a new token.

Best practices for API use

Store and reuse sessionId

Save the generated sessionId for each conversation. It is necessary to maintain interaction continuity with the same context.

Testing before final integration

Use tools like Postman or Insomnia to validate endpoints, headers, body, and responses. This helps prevent errors in the production environment.

Error monitoring

Failures in calls (such as invalid data, incorrect endpoints, or timeouts) are flagged in the ClaudIA Panel with error signals. Use this information for quick diagnostics.