Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiHosted AI, explicit consent

Compile workflow from prompt

POST /api/agent-workflows/compile

Turn a natural-language description into a runnable workflow plan. The compiler reads the workspace context (ICP, integrations, available plays) and emits { plan, definition } where plan is a human-readable summary and definition is a WorkflowDefinition DAG ready to feed into update-workflow. Pass playIds to constrain the compiler to specific plays - otherwise it picks freely from the system catalogue.

Parameters

workspaceIdrequired

string

Workspace UUID for compiler context (ICP, integrations, credentials). Required even with API key auth.

promptrequired

string

Plain-language description of the workflow you want. Example: "Every Monday, find 50 lookalikes of acme.com, enrich emails, push to my Q3 outreach campaign as drafts."

playIds

string[]

Optional. Restrict the compiler to these system play ids.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agent-workflows/compile" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"00000000-0000-4000-8000-000000000000","prompt":"example","allowHostedAi":true}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.