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

apiProvider-backed

Run workflow

POST /api/agent-workflows/{workflowId}/execute

Execute an explicitly identified saved workflow against a batch of input records. Never use this for a generic content request. Each record is one row processed by the DAG end-to-end. Execution is fire-and-forget - the route returns 202 with an execution_id immediately; poll list-workflow-runs or get-workflow-run for status.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

workflowIdrequired

string

Workflow UUID to execute.

recordsrequired

object[]

Array of input records, one per row to process. Shape matches the workflow's expected input schema.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/agent-workflows/00000000-0000-4000-8000-000000000000/execute" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"records":[{}]}'

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.