Skip to main content
The Synapse API allows healthcare systems to integrate with the Telepatia platform. Use it to set consultation context, launch the scribe for a clinician, and retrieve session results after a consultation.

​
Integration flow

  1. (Optional) List session templates — Fetch available scribe session configurations to pre-select a documentation format
  2. Set consultation context — Pre-populate patient data and optionally specify a template via scribeSessionConfigurationId
  3. Generate a login link — Create a verification code to open the scribe, passing the consultationInternalId
  4. Conduct the session — The clinician uses the scribe to record and finish the consultation
  5. Retrieve session results — Look up the scribe session by consultationInternalId

​
Base URL

EnvironmentBase URL
Productionhttps://synapse.telepatia.ai

​
API versioning

All endpoints are prefixed with a version identifier (e.g. /v1/). The current stable version is v1. When breaking changes are introduced, a new version will be published and the previous version will remain available during a deprecation period. See the API Versioning guide for details.

​
Authentication

All endpoints require a Bearer token (API key) in the Authorization header. Contact your account manager to obtain your API key. See the Authentication guide for details.

​
Next steps

Quickstart

Run through the full integration flow in under 5 minutes.

API Reference

Explore all available endpoints.