Typebot icon

Typebot

Interact with Typebot API

Chat → Start Preview Chat

AI-generated

Summary

Starts a preview chat session for the specified Typebot by sending a POST request to the Typebot chat API. Optionally includes an initial message, streaming preference, and prefilled variables.

Inputs

  • Typebot ID (required) — ID of the Typebot to preview.
  • Message — Optional message to send when starting the preview chat.
  • Is Stream Enabled — Whether to enable streaming; defaults to false.
  • Prefilled Variables — JSON object of variables to prefill. Invalid JSON causes the operation to fail.

Output shape

One or more JSON items containing the API response, with one response per input item.

The request uses the configured Typebot API credentials and chat base URL. With Continue On Fail enabled, errors are returned as items containing an error message.

Links

Discussion