ChartHero Developer Docs
API ReferenceOpenAPI JSON

Core Concepts

Reference

Changelog and versioning

The current v1 contract and the initial public documentation changelog.

Versioning

The current public contract version is v1. Public REST routes live under /external/v1, and the bundled OpenAPI artifact is published at /openapi/v1/openapi.json.

ChartHero may add optional response fields only after updating the curated public schema and compatibility guidance. The current public response schemas are strict and should be treated as the contract for generated clients and partner validation.

Changelog

Date Change
2026-06-01 Reorganized developer docs navigation around get started, core concepts, task guides, API reference, webhooks, errors, and changelog.
2026-06-01 Added initial task guides for fetching encounters, documents, transcripts, audio, receiving webhooks, and verifying webhook signatures.
2026-05-28 Initial static developer docs app for the curated public API v1 contract.
2026-05-28 Added generated OpenAPI reference and raw schema download path.
2026-05-28 Added guide pages for authentication, pagination and filters, errors, webhooks, and changelog and versioning.

Not In This Release

This release does not add SDK generation, authenticated try-it requests, partner-private docs, multiple API versions, AsyncAPI, webhook runtime delivery, webhook management UI, CI deployment, Terraform hosting, or public API write behavior.

Next steps