List Workflows
Retrieve all available workflows in your workspace.
curl -X GET "https://api.pipelinegeneration.ai/v1/workflows" \
-H "x-api-key: your_api_key"
[
{
"id": "wf_abc123",
"name": "Account Research",
"description": "Deep-dive research on a target account",
"status": "active",
"created_at": "2026-01-10T08:00:00Z"
},
{
"id": "wf_def456",
"name": "Contact Enrichment",
"description": "Enrich contact profiles with latest data",
"status": "active",
"created_at": "2026-02-05T12:00:00Z"
}
]
Trigger Workflow
Start a workflow execution. Workflows run asynchronously - the API returns a 202 Accepted response with an execution ID you can use to poll for status.
The ID of the workflow to trigger.
Target company for the workflow execution (UUID).
Target contact for the workflow execution (UUID).
Additional key-value parameters to pass to the workflow.
curl -X POST "https://api.pipelinegeneration.ai/v1/workflows/trigger" \
-H "x-api-key: your_api_key" \
-H "Content-Type: application/json" \
-d '{
"workflow_id": "wf_abc123",
"company_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"parameters": {
"depth": "comprehensive",
"include_competitors": true
}
}'
{
"execution_id": "exec_xyz789",
"workflow_id": "wf_abc123",
"status": "queued",
"created_at": "2026-03-12T10:00:00Z"
}
{
"error": "workflow_id is required"
}
Workflow executions may take up to 2 minutes depending on complexity. Use the Get Execution endpoint to poll for results.
Get Workflow Execution
Check the status and results of a workflow execution.
The unique identifier of the workflow execution.
curl -X GET "https://api.pipelinegeneration.ai/v1/workflows/executions/{execution_id}" \
-H "x-api-key: your_api_key"
{
"execution_id": "exec_xyz789",
"workflow_id": "wf_abc123",
"status": "completed",
"started_at": "2026-03-12T10:00:05Z",
"completed_at": "2026-03-12T10:01:32Z",
"result": {
"summary": "Research completed successfully",
"outputs": {
"report_id": "rpt_001",
"insights_count": 12
}
}
}
Execution Statuses
| Status | Description |
|---|
queued | Execution is waiting to start |
running | Execution is in progress |
completed | Execution finished successfully |
failed | Execution encountered an error |
