API Reference/Workflows

Workflows

Automated multi-step clinical pipelines. Workflows chain agents, FHIR reads/writes, and integrations.

The Workflow Object

FieldTypeDescription
idstringUnique workflow ID (e.g. wf_prior_auth_v2)
namestringHuman-readable name of the workflow
statusstringOne of: active | draft | paused | archived
triggerstringHow the workflow is initiated: manual | event | schedule | webhook
nodeCountintegerNumber of nodes (steps) in the workflow graph
lastRunAtnullabledatetimeISO 8601 UTC timestamp of the most recent execution
avgDurationMsintegerAverage execution duration in milliseconds
successRatenumberPercentage of runs that completed successfully (0–1)

Endpoints

Returns all workflows defined in a project.

Parameters

ParameterInTypeRequiredDescription
projectIde.g. proj_rpm_001querystringrequiredProject ID
statuse.g. activequerystringoptionalFilter by status

Request

curl "https://api.healthcloud.ai/v1/workflows?projectId=proj_rpm_001" \
  -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"

Response

Response200
{
  "data": [
    {
      "id": "wf_prior_auth_v2",
      "name": "Prior Authorization",
      "status": "active",
      "nodeCount": 8,
      "lastRunAt": "2026-03-17T14:32:00Z",
      "avgDurationMs": 4200
    }
  ]
}

Related Resources