Agents
Clinical AI agents that execute reasoning tasks against FHIR data. Supports synchronous and async run modes.
The Agent Object
| Field | Type | Description |
|---|---|---|
| id | string | Unique agent ID (e.g. agent_uti_v1) |
| name | string | Display name of the agent |
| version | string | Semantic version string (e.g. 1.2.0) |
| status | string | One of: ready | busy | error | offline |
| fhirResources | string[] | FHIR R4 resource types the agent reads or writes |
| runMode | string | Execution mode: sync (< 30 s) or async (long-running with webhook callback) |
| averageLatencyMs | integer | Average inference latency in milliseconds over the last 24 hours |
| successRate | number | Percentage of completed runs returning a structured output (0–1) |
Endpoints
Returns all agents available in the project.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| projectIde.g. proj_rpm_001 | query | string | required | Project ID |
Request
curl "https://api.healthcloud.ai/v1/agents?projectId=proj_rpm_001" \ -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"
Response
Response200
{ "data": [ { "id": "agent_uti_v1", "name": "UTI Screening Agent", "status": "ready", "version": "1.2.0", "fhirResources": ["Observation", "Condition"] } ] }