mcpHosted AI, explicit consent

Compile workflow from prompt

tools/call

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

MCP tools/calljson

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "compile-workflow-from-prompt",
    "arguments": {
      "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.

JSON-RPC errors

-32602: Invalid parameters. Field-level details are returned in the JSON-RPC error data.
-32001: Authentication or hosted AI consent is required.
-32003: Workspace access is denied.
-32029: The request was rate limited.