Skip to main content
POST
Run the website builder agent

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

websiteId
string
required

Body

application/json

Run the website builder agent

companyId
string
required

Company ID that owns the website

threadId
string
required

Thread to run in. It must be on a review branch (see the thread's branch).

message
string
required

What to build or change, as you would ask a web designer: the business, audience, pages, sections, copy and tone.

Response

The agent is running

threadId
string
messageId
string

The agent's reply message; read the thread until it is no longer loading

status
string

"running"