API Reference

API Explorer

Browse and test every HealthCloud API endpoint interactively. Select an example request, inspect the response, and get API key to use in your application.

Base URL

https://api.healthcloud.dev

Endpoints

Example Requests

GET/v1/assets

Description

Fetch a list of available AI agents from the HealthCloud Marketplace.

Headers

Authorization:Bearer hc_test_sk_demo
Content-Type:application/json

Query Params

type=agent
limit=10

Click ▶ Run Request to see the response

Concepts·Object Model·Guides·Open Studio

Workflow Run Example

Trigger a complete clinical AI workflow — from FHIR observation input through multi-agent orchestration to alert generation and CPT billing event capture.

POST/api/v1/workflows/runs

Request Body

{
  "workflow_id": "wf_rpm_alert_pipeline",
  "trigger": "event",
  "input": {
    "observation_id": "obs_456",
    "patient_id": "pat_123",
    "device_type": "CGM"
  }
}

Response

Click ▶ Run Workflow to see the response

Webhook Test

Test your webhook endpoint by sending a sample workflow.run.completed event payload. Configure your endpoint URL and inspect what HealthCloud will POST to your server.

POST/api/v1/webhooks/test
Not sent

Sample Payload

{
  "event": "workflow.run.completed",
  "timestamp": "2026-03-17T14:22:43Z",
  "org_id": "org_healthsystem_01",
  "project_id": "proj_rpm_2026",
  "payload": {
    "run_id": "run_8f2a91c",
    "workflow_id": "wf_rpm_alert_pipeline",
    "status": "completed",
    "duration_ms": 412,
    "alert_generated": true,
    "severity": "HIGH"
  }
}