Overview

Use the Doctronic API to run clinical conversations, handle events, book care, and retrieve consultation documents.

The Doctronic API lets your backend create patients, run streamed clinical conversations, handle safety and workflow events, book appointments, and retrieve consultation summaries and SOAP notes.

Run the quickstart

Create a patient, stream a consultation, and retrieve a consultation document.

Choose an integration pattern

See what is available through the public API and what Doctronic configures with you.

Handle safety events

Implement guardian, conversation, error, and completion states.

View the API reference

Inspect operations, parameters, schemas, and responses from the OpenAPI contract.

Key terms

Term	Meaning
User	The Doctronic record associated with a patient in your system
Chat	One clinical conversation for that user
SSE event	A named update sent while a chat response is streaming
Guardian event	A safety signal that follows the handling agreed for your integration
Artifact	The API resource containing a consultation summary or SOAP note

How an integration works

The API is called from your backend. The organization token must not be sent to a browser or mobile application.

Create a Doctronic user and store its ID with the patient in your system.
Create a chat and send patient turns to its streaming endpoint.
Render assistant text from message.* events and handle control events in separate code paths.
When ai_consultation.complete arrives, retrieve the documents your workflow needs.
If applicable, continue into an appointment or pharmacy workflow.

What the public API supports

Capability	API surface
Patient records	Create and retrieve users scoped to your organization
Clinical conversations	Create chats, stream turns, list chats, and restore transcripts
Safety and workflow events	Handle guardian, conversation, call-to-action, error, and completion events
Appointments and pharmacies	Find availability, manage scheduled or ASAP appointments, and save a pharmacy
Consultation documents	Retrieve long summaries, short summaries, and SOAP notes by artifact ID

Some capabilities, including outbound webhooks and implementation-specific routing, are configured by Doctronic. Other workflows require joint design. The integration patterns page labels each category.

Start building

Access is coordinated by Doctronic

Credentials are provisioned manually. Contact your Doctronic business or implementation contact for staging or production access. If you do not have a contact, email business@doctronic.ai. Do not include credentials or patient information in email.