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

# MediSync API Documentation

> A medical AI platform with REST, real-time speech, and clinical-system interoperability APIs for healthcare integrators

<img className="block dark:hidden" src="https://mintcdn.com/medisync/wny0wt448RXOrFpU/images/hero-light.png?fit=max&auto=format&n=wny0wt448RXOrFpU&q=85&s=fb9d018133c17296097b124fd7eb52f2" alt="MediSync Medical AI Platform" width="1080" height="414" data-path="images/hero-light.png" />

<img className="hidden dark:block" src="https://mintcdn.com/medisync/wny0wt448RXOrFpU/images/hero-dark.png?fit=max&auto=format&n=wny0wt448RXOrFpU&q=85&s=0b10ff7ff46c4676a2dca17345394b75" alt="MediSync Medical AI Platform" width="1080" height="414" data-path="images/hero-dark.png" />

## Welcome to the MediSync API

MediSync is a medical AI platform for clinical documentation. Our APIs let you integrate AI-powered medical transcription, clinical note generation, and clinical-system interoperability into your own applications and workflows.

The platform exposes three APIs:

<CardGroup cols={3}>
  <Card title="Dashboard API" icon="code" href="/api-reference/introduction" color="#172554">
    The REST API for appointments, recordings, transcriptions, and AI-generated clinical notes and documents.
  </Card>

  <Card title="Speech API" icon="microphone" href="/websocket/introduction" color="#3b82f6">
    Real-time speech-to-text over a single authenticated WebSocket, with word-level timings and optional speaker separation.
  </Card>

  <Card title="Connect API" icon="network-wired" href="/connect/introduction" color="#1e3a8a">
    MediSync Connect — standards-based interoperability with hospital (KIS) and practice (PVS/EHR) systems.
  </Card>
</CardGroup>

## Key features

<CardGroup cols={2}>
  <Card title="AI-Powered Clinical Notes" icon="robot" href="/api-reference/notes/create">
    Generate structured clinical notes from appointment transcriptions using medical AI.
  </Card>

  <Card title="Real-time Transcription" icon="waveform-lines" href="/websocket/introduction">
    Live audio transcription with word-level timings and optional speaker separation.
  </Card>

  <Card title="Appointment Workflow" icon="calendar-days" href="/api-reference/appointments/create">
    Manage the full appointment lifecycle, from planning to AI-generated documentation.
  </Card>

  <Card title="Clinical-System Interoperability" icon="hospital" href="/connect/introduction">
    Exchange patient context and clinical documentation with KIS/PVS systems over open standards (FHIR R4, SMART on FHIR, HL7 CDA).
  </Card>

  <Card title="Document Management" icon="file-medical" href="/api-reference/documents/upload">
    Upload, store, and manage clinical documents alongside each appointment.
  </Card>

  <Card title="Secure by design" icon="shield-check" href="/authentication">
    JWT-authenticated APIs and GDPR-aligned handling of clinical data.
  </Card>
</CardGroup>

## Base URLs

<Note>
  **Dashboard API (REST)**: `https://app.medisync.me/api/`

  **Speech API (WebSocket)**: `wss://speech.medisync.me/api/v2/ws/transcribe?token=<JWT>`
</Note>

## Get started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Authenticate and run your first appointment-to-notes workflow.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn about JWT authentication and how to obtain a token.
  </Card>
</CardGroup>

## Support

Need help integrating? Email [support@medisync.me](mailto:support@medisync.me).