Skip to content
Hermes Health API
Search the documentation
Guides
OpenAPI spec
Sign in
Introduction
Base URL
Authentication
Idempotency
Versioning
Errors
Status codes
Rate limits
Setup
Account
Retrieve your account
Projects
The project object
Create a project (Hermes-generated ID)
Retrieve a project
Upsert a project by ID
Update a project
Delete a project
Project files
The file object
Download a project file
Upload a project file
Delete a project file
Check a project file's status
Patients
Patients
The patient object
Create a patient (Hermes-generated ID)
Retrieve a patient
Upsert a patient by ID
Update a patient
Delete a patient
Browse patients
Patient authorization
Retrieve a patient's authorization
Delete a patient's authorization
Check a patient authorization's status
Patient search
Update a patient's requested searches
Patient notes
List a patient's notes
Add a note to a patient
Delete a patient note
Auth intake
Mint an auth-intake token for a new patient
Mint an auth-intake token for a patient
Mint an auth-intake token for a record request
Auth check
Retrieve a standalone auth check
Mint an upload URL for an auth check
Mint an auth-check embed token
Re-run a standalone auth-check
Clinical data
Visits
Browse visits
Diagnoses
Browse diagnoses
Browse diagnosis categories
Browse diagnosis codes
Procedures
Browse procedure codes
Browse procedures
Prescription fills
Browse prescription fills
Lab accessions
Browse lab accessions
Lab results
Browse lab results
Clinical data embed
Mint a clinical-data embed token
Record retrieval
Record requests
The record request object
Create a record request (Hermes-generated ID)
Upsert a record request by ID
Retrieve a record request
Update a record request
Browse record requests
Record request files
The file object
List a record request's deliverables
Download a deliverable
Delete a deliverable
Check a deliverable's status
Rename a deliverable
List a record request's documents
Download a record request document
Mint an upload URL for a record request document
Rename a record request document
Delete a record request document
Check a document's status
Download a record request attachment
Delete a record request attachment
Check an attachment's status
Record request notes
Add a note to a record request
Update a record request note
Delete a record request note
Record request authorization
Retrieve a record request's authorization
Facilities
Sites
Create a site
Retrieve a site
Site finder
Start a site-finder job
Mint a site-finder embed token
Retrieve a site-finder job
Site research
Trigger AI research for a site
Webhooks
Webhooks
Changelog
2026-10-07: Self-serve webhook events are picked from the Entity dropdown
2026-10-06: Companies report whether in-network requests are enabled
2026-10-06: Webhooks subscribe to named events
2026-10-06: Joined columns keep their access rules; site tax ID is Hermes-only
2026-10-06: Embed tokens without parentOrigin deprecated; parentOrigin checked strictly
2026-10-05: Webhook event schemas for clinical data added and AI research completed
2026-10-05: Purpose alignment judged against the project’s purpose; dates of service pass on coverage
2026-10-04: Deleting a patient’s authorization answers 404 for an unknown patient
2026-10-04: Browse columns and value formats described
2026-10-04: Machine-readable docs, deprecation flags and documented 401s
Endpoints
Webhooks