Skip to main content
POST
Chat endpoint for the in-memory frame builder.

Authorizations

X-API-Key
string
header
required

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

Body

application/json

Frame builder chat request

Request body for frame builder chat

companyId
string
required

Company ID

message
string
required

User message/prompt

brandImages
object[]

Brand images with url, name, description

currentHtml
string

Current HTML to modify

frameHeight
integer

Frame height in pixels (default: 1024)

frameName
string

Name of the frame

frameWidth
integer

Frame width in pixels (default: 1024)

imageStylePrompt
string

Style prompt for the brand

messages
object[]

Previous chat messages for context

Response

Invalid request

error
string

Error message