How-to

If you’d like to execute the typebot in preview mode, you will need to provide the ID of the building typebot available in the editor URL:

For published typebot execution, you need to provide the public typebot ID available here:

In your workspace dashboard, head over to Settings & Members > Workspace > Settings and copy the workspace ID

If you enabled stream, whenever a AI message should be streamed, you will receive that kind of JSON response:

{
  "messages": [],
  "clientSideActions": [
    {
      "type": "stream",
      "stream": true,
      "expectsDedicatedReply": true
    }
  ]
}

The bot is ready to accept the message streaming. You now need to send the following query:

curl -X POST https://typebot.co/api/v2/sessions/{sessionId}/streamMessage

Where {sessionId} should be replaced by the session ID you got from the start chat response.

This endpoint will send Server-Sent events with all the information to display the streamed message.

Once it is done, you can contine the flow by sending a continue chat request with the streamed message as the message content.

On this page