sdkHosted AI, explicit consent

Compile workflow from prompt

pipeline.compileWorkflowFromPrompt

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

TypeScripttypescript

await pipeline.compileWorkflowFromPrompt({
  "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.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.