Public API v1

API Reference

Use this page as the entry point for ChartHero's public REST and webhook contracts. The generated endpoint reference below is built from OpenAPI 3.1.0, contract v1.

Base URL

Use the shared host that matches the environment for your API key.

Production

https://api.charthero.ai/external/v1

Staging

https://api.charthero-staging.com/external/v1

Authentication

Send the API key from server-side code with this header.

Authorization: Bearer <api_key>Review authentication

OpenAPI JSON

Download the exact bundled schema used by this reference.

OpenAPI JSON

Resources

9 REST routes

Encounters

List encounters and read one encounter by opaque ID.

GET /external/v1/encountersGET /external/v1/encounters/{encounter_id}

Encounter operations Encounter guide

Documents and transcripts

List clinical documents and read document or transcript details.

GET /external/v1/documentsGET /external/v1/encounters/{encounter_id}/documents/{document_id}

Document operations Document guide

Audio

Request short-lived URLs for eligible recording-backed audio.

GET /external/v1/encounters/{encounter_id}/documents/{document_id}/audio

Audio operation Audio guide

Actors

Resolve the people and API keys that other resources reference.

GET /external/v1/actors

Actor operation Actor guide

Evaluations

List evaluations by completion time, read one evaluation, and discover definitions.

GET /external/v1/evaluationsGET /external/v1/evaluations/{evaluation_id}GET /external/v1/evaluation-definitions

Evaluation operations Evaluation guide

Webhooks

Available for activated subscriptions

Review pointer notifications and receiver response rules.

recording.transcript_readyevaluation.completed

Webhook operation Webhook guide

Generated from OpenAPI

ChartHero Public API

The raw schema is available at /openapi/v1/openapi.json.

Surface	Summary
`GET /external/v1/actors`	List actors
`GET /external/v1/documents`	List documents
`GET /external/v1/encounters`	List encounters
`GET /external/v1/encounters/{encounter_id}`	Get an encounter
`GET /external/v1/encounters/{encounter_id}/documents/{document_id}`	Get a document
`GET /external/v1/encounters/{encounter_id}/documents/{document_id}/audio`	Get a document audio URL
`GET /external/v1/evaluation-definitions`	List evaluation definitions
`GET /external/v1/evaluations`	List evaluations
`GET /external/v1/evaluations/{evaluation_id}`	Get an evaluation
`evaluation.completed`	Webhook contract (available_for_activated_subscriptions): Receive evaluation completed notifications
`recording.transcript_ready`	Webhook contract (available_for_activated_subscriptions): Receive recording transcript-ready notifications

Loading generated API reference

Rendering the bundled OpenAPI contract.