Skip to main content
POST
Chat endpoint for the AI canvas builder.

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

canvas_id
string
required

Body

application/json

Chat message

Chat message for the canvas 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)

Response

Missing required fields

error
string

Error message