Skip to main content
Squire is designed to integrate directly into Electronic Health Record (EHR) systems, giving healthcare providers access to AI-powered consultation tools without leaving their familiar workflow. You have two integration paths to choose from depending on how much control you need over the user interface and how quickly you need to ship.

​
Choose your integration path

Squire SDK

A JavaScript SDK for web-based EHR clients. Use this when you need full control over the look, feel, and behavior of the Squire experience inside your application.

Squire Widget

A pre-built, embeddable UI component. Use this for quick integrations where speed matters more than deep UI customization.

​
SDK

The Squire JavaScript SDK gives you complete control over how Squire appears and behaves in your EHR interface. You initialize the SDK with a user access token, then use its API to start and stop recordings, listen for structured report events, and write consultation output directly into your EHR data model. Choose the SDK when:
  • Your EHR has a custom web-based frontend built on React, Angular, Vue, or similar.
  • You need the Squire experience to match your existing design system.
  • You want direct access to consultation output via JavaScript events.

​
Widget

The Squire Widget is a ready-to-use UI component you embed in any web application with a few lines of code. It handles recording controls, status indicators, and report display out of the box — no custom UI work required. Choose the Widget when:
  • You need to add Squire to an existing web app quickly.
  • Your team has limited frontend engineering capacity.
  • A consistent, pre-built interface meets your users’ needs.

​
Before you integrate

Regardless of which path you choose, you need to complete two prerequisite steps first:
1

Create an API key

Log in to the Squire Portal and generate an API key for your target environment. See Portal setup for instructions.
2

Implement authentication

Set up a backend endpoint that exchanges your API key for a short-lived user access token. See Authentication for the full token request reference.