Draft an automation from a prompt

post

https://{youraccountname}.api-us1.com/api/3/ai/automations/schema

Runs the automation schema builder on a natural-language prompt and returns a workflow proposal. Nothing is saved; persisting the automation requires a separate build call. Answers 403 when the API user may not manage automations, 422 when the model returns more than one workflow in one call, and 500 when the builder or model fails.

Body Params

A natural-language prompt and optional composer context for drafting an automation.

prompt

string

required

What the account wants the automation to do, in the customer's words.

customerWords

string | null

The customer's original words when the brief or prompt may omit a name the automation should reuse.

failOnError

boolean | null

Whether a later build call should fail on the first blocking error. Accepted on this route for compatibility with the create sequence; this action does not read it.

sessionId

string | null

Automation agent session identifier when the caller is continuing a chat turn.

slug

string | null

Recipe slug when the caller is starting from a stored recipe template.

referencedAssets

array of objects

Lists, tags, or other composer chips the caller attached to the prompt.

referencedAssets

Responses

200A workflow proposal plus any trigger or action types removed for the account.

403The API user may not manage automations.

422The proposal must contain exactly one workflow.

500The schema builder or model could not produce a proposal.