API Documentation
Reference for Regenemm Hub APIs grouped by how teams use them: runtime workflows, templates, voice audio, named spokes, observability, and Regenemm Billing.
Regenemm Voice is the Hub and clinical control plane. Spokes are bounded workflow surfaces that call Hub APIs. Spokes do not own durable clinical truth and do not access core data stores directly.
This page describes the public developer-preview contract shape. Availability, endpoint paths, and schema versions may change before general API availability.
Hub APIs use Cognito/OIDC bearer tokens. Each request is tenant-scoped, spoke-identified, and request-correlated. Spoke clients use approved OAuth flows and PKCE where required by their surface.
Authorization: Bearer <access_token>
X-Tenant-Id: <tenant_uuid>
X-Spoke-Id: hospital_hub
X-Request-Id: <uuidv7>
X-Idempotency-Key: <required_for_state_mutations>Errors follow RFC7807 Problem Details and always include the request identifier.
{
"type": "https://regenemm.com/problems/validation",
"title": "Validation failed",
"status": 400,
"detail": "One or more fields are invalid.",
"requestId": "0192f2c6-...",
"errors": [
{ "field": "templateId", "message": "templateId is required" }
]
}Required Headers
| Header | Purpose |
|---|---|
| Authorization | Bearer <Cognito access token> |
| X-Tenant-Id | <uuid> |
| X-Spoke-Id | <string> |
| X-Request-Id | <uuidv7 preferred> |
| X-Idempotency-Key | Required for state mutations |
Canonical Artifact Lifecycle
Only authorised clinical users can move material outputs into approved, exported, or shared states. If verification cannot run, outputs fail closed and remain in review.
API Families
Public API documentation is organised around the major surfaces Regenemm expects teams to integrate with. Each family inherits the same Hub governance, consent, release-gate, and audit rules.
Core Hub workflow APIs used while clinical work is being captured, reviewed, approved, and shared.
Platform Config
Feature flags, kill switches, timeouts, limits, and fail-closed runtime settings.
/v1/platform/config/{spokeId}Encounters
Encounter containers that bind audio, transcripts, artifacts, exports, audit, and consent.
/v1/encounters/v1/encounters/{encounterId}Clinical Artifacts
Generated outputs, edits, versions, and artifact metadata.
/v1/encounters/{encounterId}/artifacts:generate/v1/encounters/{encounterId}/artifacts/v1/artifacts/{artifactId}Verification and Release Gates
Clinician review controls that move material outputs toward approved release.
/v1/artifacts/{artifactId}:verify/v1/artifacts/{artifactId}:approve/v1/artifacts/{artifactId}:reject/v1/artifacts/{artifactId}:recall/v1/release-gates/{gateName}/queueConsent and Sharing
Consent contracts, recipient-aware sharing, purpose limitation, expiry, and revocation.
/v1/consents/v1/shares/v1/shares/{shareId}Template definitions for the clinical outputs Regenemm creates from a shared source of truth.
Template Catalog
Available clinical note, return letter, referral, care plan, and patient-summary templates.
/v1/templates/v1/templates/{templateId}Template Versions
Versioned template releases and compatibility with artifact schemas.
/v1/templates/{templateId}/versions/v1/templates/{templateId}/versions/{versionId}Artifact Schema Mapping
Allowed artifact types, required fields, recipient class, and release-gate requirements.
/v1/templates/{templateId}/artifact-schemasValidation Policies
Template-specific confidence thresholds, evidence requirements, and review rules.
/v1/templates/{templateId}/validation-policyAudio capture, transcript ingestion, diarisation metadata, and audio-to-artifact workflow control.
Audio Sessions
Create and manage governed audio capture sessions for consultations and dictation.
/v1/audio/sessions/v1/audio/sessions/{sessionId}Audio Uploads
Upload chunks, finalize recordings, and bind audio evidence to an encounter.
/v1/audio/sessions/{sessionId}/chunks/v1/audio/sessions/{sessionId}:finalizeTranscripts
Store transcript segments after diarisation and speech recognition.
/v1/encounters/{encounterId}/transcripts/v1/encounters/{encounterId}/transcriptsDiarisation Metadata
Speaker labels, timestamps, confidence values, and non-PHI operational counts.
/v1/transcripts/{transcriptId}/diarisationAudio-to-Artifact Jobs
Trigger the governed drafting pipeline from approved audio/transcript evidence.
/v1/encounters/{encounterId}/artifacts:generate/v1/jobs/{jobId}Audit-safe telemetry for operators without exposing PHI in logs, metrics, traces, or URLs.
Health and Readiness
Hub health, spoke readiness, dependency checks, and service availability.
/v1/health/v1/spokes/{spokeId}/readinessRequest Correlation
Trace request IDs across Hub and spoke boundaries without carrying patient content.
/v1/requests/{requestId}Telemetry Metrics
Counts, durations, queue depth, failure categories, and non-PHI operational signals.
/v1/telemetry/metricsAudit Events
Append-only workflow history for clinical state transitions and release actions.
/v1/audit/events/v1/audit/events/{eventId}Regenemm Billing APIs for usage accounting, claim readiness, and operational attribution.
Usage Summary
Aggregate workflow usage by tenant, spoke, period, artifact type, and release state.
/v1/usage/summaryBillable Workflow Events
Billable event records derived from approved Hub events and release gates.
/v1/billing/events/v1/billing/events/{eventId}Claim Readiness
Operational checks that support billing preparation without becoming clinical truth.
/v1/billing/claim-readiness/{encounterId}Billing Evidence
Evidence references for invoicing, internal review, and billing audit.
/v1/billing/evidence/{encounterId}Spokes can resolve their Hub context without exposing registry internals. This supports operator dashboards and safer runtime checks.
GET /v1/spokes/whoami
{
"tenantId": "ten_...",
"spokeId": "hospital_hub",
"environment": "edge-staging",
"hubTarget": "edge-staging",
"scopes": ["regenemm/spoke.read", "regenemm/spoke.write"],
"policyVersion": "2026-05-02"
}Usage APIs expose operational counts, not patient content. Billing-readiness references approved Hub events and evidence, never unreviewed clinical text.
GET /v1/usage/summary?periodDays=30&spokeId=hospital_hub
{
"usage": {
"encountersCreated": 128,
"artifactsGenerated": 486,
"verificationRuns": 486,
"artifactsApproved": 421,
"exportsCreated": 312,
"sharesDispatched": 184
}
}Named Spoke APIs
Named spoke APIs document the product-specific surfaces around Regenemm Voice: RegenemiOS, Link, Connect, Triage, Hospital Hub, Home Hub, Knowledge, Biometrics, Billing, Medico-legal, and Speed. They are thin spokes: workflow UX and domain logic call the Hub, while durable clinical state remains Hub-governed.
RegenemiOS API
regenemiosNative iOS capture, offline-first workflow sync, clinician UX state, and Hub handoff.
Regenemm Link API
linkPatient-controlled records, consent grants, traceable sharing, and clinician snapshot release.
Regenemm Hospital Hub API
hospital_hubHospital workflows, ward context, handover, and care-team coordination.
Regenemm Home Hub API
home_hubHome monitoring, post-discharge care, patient continuity, and carer-supported workflows.
Regenemm Triage API
triageTriage intake, priority signals, missing workflow items, escalation preparation, and queue routing.
Regenemm Knowledge API
knowledge_baseEvidence retrieval, governed RAG context, guideline search, and citation bundle support.
Regenemm Connect API
connectFHIR, HL7, EMR, EHR, My Health Record, and interoperability audit pathways.
Regenemm Biometrics API
biometricsWearable signals, vital sign context, HealthKit/device integrations, and clinical correlation events.
Regenemm Medico-legal API
medico_legalChronology generation, evidence packaging, source provenance, and disclosure bundle controls.
Regenemm Billing Spoke API
billingBilling-specific spoke workflows for usage review, claim evidence, and cost attribution.
Regenemm Speed API
speedPerformance medicine, rehabilitation tracking, return-to-play workflows, and athlete context.
PHI must not appear in telemetry, analytics, URLs, logs, error messages, metric labels, or traces. Audit records use IDs, hashes, timestamps, state transitions, role information, confidence metrics, and event counts.
Billing and operator APIs never become clinical truth. They reference Hub-governed events and approved evidence while the Hub remains canonical for clinical state, release gates, provenance, and audit.