> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telepatia.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Scribe API Overview

> External-facing REST API for integrating with Telepatia

The Scribe 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

0. **Pick (or build) a Smart Template** -- Define which sections Telepatia generates using curated [Telepatia Prompts](/scribe-api/telepatia-nodes). Reuse across consultations.
1. **Set consultation context** -- Pre-populate patient data and attach the Smart Template (inline JSON or by `medicalRecordConfigurationId`).
2. **Generate a login link** -- Create a verification code to open the scribe, passing the `consultationInternalId`.
3. **Conduct the session** -- The clinician uses the scribe to record and finish the consultation.
4. **Retrieve session results** -- Look up the scribe session by `consultationInternalId`.

<Tip>
  **Smart Templates drive documentation.** Build one with curated **Telepatia Sections** for clinical quality, or mix in **Custom Sections** for sections that aren't covered. See [Smart Templates](/scribe-api/smart-templates).
</Tip>

## Base URL

| Environment | Base URL                          |
| ----------- | --------------------------------- |
| Production  | `https://scribe-api.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](/scribe-api/versioning) 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](/scribe-api/authentication) for details.

## Downloads

Import the API into any OpenAPI 3.1 tooling, load the ready-made Postman collection, or copy a per-endpoint prompt straight into your AI coding assistant.

<CardGroup cols={2}>
  <Card title="Doctor API — OpenAPI" icon="file-code" href="/scribe-api/openapi.json">
    Download the Doctor API spec (JSON).
  </Card>

  <Card title="Doctor API — Postman" icon="rocket" href="/scribe-api/synapse-doctor.postman_collection.json">
    Import the Doctor API into Postman or Insomnia.
  </Card>

  <Card title="Institutional API — OpenAPI" icon="file-code" href="/scribe-api/openapi-institutional.json">
    Download the Institutional API spec (JSON).
  </Card>

  <Card title="Institutional API — Postman" icon="rocket" href="/scribe-api/synapse-institutional.postman_collection.json">
    Import the Institutional API into Postman or Insomnia.
  </Card>

  <Card title="AI Prompts" icon="sparkles" href="/scribe-api/prompts/setup">
    Copy-ready prompts per endpoint, drop-into-Cursor/Claude/Copilot to scaffold an integration.
  </Card>
</CardGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Smart Templates" icon="wand-magic-sparkles" href="/scribe-api/smart-templates">
    Design how Telepatia generates each medical record — the recommended starting point.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/scribe-api/quickstart">
    Run through the full integration flow in under 5 minutes.
  </Card>

  <Card title="Telepatia Prompts" icon="stethoscope" href="/scribe-api/telepatia-nodes">
    Curated prompts maintained by Telepatia's clinical team.
  </Card>

  <Card title="API Reference" icon="square-terminal" href="/scribe-api/api-reference">
    Explore all available endpoints.
  </Card>
</CardGroup>