Skip to main content
POST
Chat with the visual builder AI agent about a template's email design.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

templateId
string
required

Body

application/json

Chat message

Chat message for the visual email builder agent

companyId
string
required

Company ID

message
string

User message

threadId
string

Thread to continue (defaults to the active thread)

clientMessageId
string

Client-generated id for the user message

attachments
object[]

Image attachments (design references)

bodyDocument
string

The document currently open in the visual builder, including unsaved edits. The agent starts from it; defaults to the saved bodyDocument

variables
string[]

Smart list field tokens (without braces) the email may use

Response

Missing required fields

error
string

Error message