# Squire Developers

> Integrate Squire consultation notes, dictation and patient intake into your medical software with the Squire JavaScript SDK, widgets and REST API.

Every page is available as Markdown by appending `.md` to its URL.
The complete documentation as a single file: https://developers.squire.eu/llms-full.txt

## Overview

- [Squire developer documentation](https://developers.squire.eu/index.md): Integrate Squire consultation notes, dictation and patient intake into your medical software with the JavaScript SDK, widgets and REST API.

## Get started

- [Get started](https://developers.squire.eu/get-started.md): Set up authentication and install the Squire SDK, then choose the product to integrate.
- [Authentication](https://developers.squire.eu/get-started/authentication.md): Exchange your Squire API key for a user access token on your server and initialize the SDK with it.
- [Installation](https://developers.squire.eu/get-started/sdk-installation.md): Configure the private npm registry and install the Squire SDK in your client.

## Consultation

- [Consultation](https://developers.squire.eu/consultation.md): Record consultation audio and turn it into structured clinical output with the SDK or the widget.
- [Recording with the SDK](https://developers.squire.eu/consultation/sdk.md): Initialize the Squire SDK, list microphones, start and stop recordings, and receive the consultation summary.
- [Consultation Widget](https://developers.squire.eu/consultation/widget.md): Embed the Consultation widget for a complete recording interface with theming, events and templates.
- [Templates](https://developers.squire.eu/consultation/templates.md): Define custom templates so consultation output maps directly to your system's data model.
- [Data output](https://developers.squire.eu/consultation/output.md): Reference for the JSON consultation summary: metadata, generation result, templates, sections and fields.
- [Multi-SOAP](https://developers.squire.eu/consultation/multi-soap.md): Split one consultation into multiple SOAP notes or merge split notes back together.
- [Product usage](https://developers.squire.eu/consultation/product-usage.md): Read the remaining allowance per product for the signed-in user with user.getUsage().
- [Terms & Conditions](https://developers.squire.eu/consultation/terms-and-conditions.md): Check whether an end user accepted the Terms & Conditions and handle the acceptance flow.
- [Error Handling](https://developers.squire.eu/consultation/error-handling.md): SDK session states, built-in retries, explicit error handling, API errors and log levels.

## Dictation

- [Dictation](https://developers.squire.eu/dictation.md): Stream speech to a live transcript with the SDK, with finalized and in-progress text.

## Intake

- [Intake](https://developers.squire.eu/intake.md): Digitize patient intake with the Scheduling API, the Protocol widget and the Summary widget.
- [Scheduling](https://developers.squire.eu/intake/scheduling.md): Create intake sessions from your calendar system with the SDK.
- [Protocol widget](https://developers.squire.eu/intake/settings-widget.md): Embed the Protocol widget so providers can create and manage intake questionnaires.
- [Summary Widget](https://developers.squire.eu/intake/summary-widget.md): Embed the Summary widget to show intake sessions and completed summaries inside your application.
- [Email & DNS Setup](https://developers.squire.eu/intake/email-setup.md): Send intake emails from your own domain and serve intake pages on a custom hostname.

## Medical coding

- [Coding](https://developers.squire.eu/medical-coding.md): Encode clinical free text or a consultation report into SNOMED CT or ICD-10 codes with the medical coding API.

## Widgets

- [Widgets](https://developers.squire.eu/widgets.md): Ready-made, themeable UI components mounted through the SDK's mountWidget method.
- [Microphone Quality Test](https://developers.squire.eu/widgets/microphone-quality-test.md): Embed the Microphone Quality Test widget so users can verify their audio setup before recording.

## Reference

- [Reference](https://developers.squire.eu/reference.md): Supporting reference material that applies across Squire products.
- [Changelog](https://developers.squire.eu/reference/sdk-changelog.md): Release notes for every version of the Squire JavaScript SDK.
- [Languages](https://developers.squire.eu/reference/languages.md): Supported input and output languages, including automatic language detection.
- [Microphones](https://developers.squire.eu/reference/microphones.md): Recommended microphones and how to embed the Squire microphone store on your site.
- [FHIR interface](https://developers.squire.eu/reference/fhir.md): Receive consultation data as FHIR resources: observations, conditions, procedures and medications.
- [Coding agents](https://developers.squire.eu/reference/coding-agents.md): Point Claude Code, Cursor, GitHub Copilot and other coding agents at the Squire documentation and SDK types.
- [Portal](https://developers.squire.eu/reference/portal.md): Manage API keys, environments and team access in the Squire Portal.
- [Microsoft Entra ID (SSO)](https://developers.squire.eu/reference/entra-id-sso.md): Authorize the Squire app in your Microsoft Entra ID tenant so your users can sign in with SSO.
- [Support](https://developers.squire.eu/reference/support.md): How to reach the Squire integrations team.