Workflows

List Workflows

GET /v1/workflows
GET /v1/workflows?featureDynastySlug=sales-email-cold-outreach
X-API-Key: dist_YOUR_KEY

Returns all workflows, optionally filtered by feature.

Get Workflow

GET /v1/workflows/:workflowId
X-API-Key: dist_YOUR_KEY

Returns full workflow details including the DAG (directed acyclic graph), nodes, edges, required providers, and version info.

Workflow Summary

GET /v1/workflows/:workflowId/summary
X-API-Key: dist_YOUR_KEY

Returns a human-readable summary of what the workflow does, its steps, and required API providers.

{
  "workflowSlug": "sales-email-cold-outreach-apex-v4",
  "summary": "Finds leads via Apollo, generates personalized cold emails...",
  "requiredProviders": ["anthropic", "apollo", "resend"],
  "steps": [
    "Scrape brand website",
    "Search leads via Apollo",
    "Generate personalized emails",
    "Send via Resend",
    "Track delivery and replies"
  ]
}

Key Status

GET /v1/workflows/:workflowId/key-status
X-API-Key: dist_YOUR_KEY

Checks whether all required API keys are configured for this workflow.

{
  "workflowSlug": "sales-email-cold-outreach-apex-v4",
  "ready": true,
  "keys": [
    { "provider": "anthropic", "configured": true, "keySource": "platform" },
    { "provider": "apollo", "configured": true, "keySource": "org" }
  ],
  "missing": []
}

TypeScript Client

const { workflows } = await client.listWorkflows({ featureDynastySlug: "sales-email-cold-outreach" });
const workflow = await client.getWorkflow("wf_abc123");
const summary = await client.getWorkflowSummary("wf_abc123");
const keyStatus = await client.getWorkflowKeyStatus("wf_abc123");