Overview
See what the Doctronic API does, how an integration fits together, and where to start building.
The Doctronic API runs AI clinical consultations inside your product. Your backend creates a record for each patient, streams the consultation turn by turn, reacts to typed safety and workflow events, and retrieves the resulting summaries and SOAP notes.
How an integration works
Every call comes from your backend. One consultation moves through these resources:
- Patient → user. Create a Doctronic user for the patient and store its
mem_…ID with the patient record in your system. See Users. - User → chat. Create a chat for the consultation. One chat holds one consultation.
- Chat → streamed turn. Send each patient message to the chat's stream endpoint. The reply arrives as Server-Sent Events while the assistant writes it.
- Turn → typed events.
message.*events carry the text to render. Separate events carry state:guardianfor safety,conversation.endandskill_code.ctafor next steps, andai_consultation.completewhen the consultation is done. Drive product state from these events, not from the assistant's wording. - Completion → consultation documents.
ai_consultation.completelists the IDs of the long summary, short summary, and SOAP note. Fetch each one withGET /artifacts/{artifactId}/. - Optional care. Continue into a Doctronic appointment, save a pharmacy, or store insurance coverage for the same user.
| Term | Meaning |
|---|---|
| User | The Doctronic record for one patient, scoped to your organization |
| Chat | The API resource for one consultation |
guardian event | A stream event that tells your product to run its agreed safety behavior |
| Artifact | The API resource for a consultation document: a summary, SOAP note, or clinician note |
What you can build
| Workflow | Availability | Start with |
|---|---|---|
| A patient holds a clinical conversation in your product | Public API | Conversations |
| Your workflow passes prior context into the consultation | Public API | Pass context |
| Your product reacts to safety and next-step events | Public API | Safety |
| Your records include summaries, SOAP notes, and clinician notes | Public API | Consultation documents |
| The patient books a scheduled or ASAP Doctronic visit and picks a pharmacy | Public API, enabled per organization | Appointments and pharmacy |
| Your backend stores the patient's insurance coverage | Public API | Coverage |
| Your system receives appointment and artifact updates asynchronously | Configured by Doctronic | Webhooks |
"Public API" means the operation is in the published OpenAPI 3.1 contract. Doctronic enables credentials, workflows, and production access for each organization; see Get access.
Where to go
Quickstart
Create a user, open a chat, and stream your first assistant message.
SDKs
Install the TypeScript or Python SDK and call the API with typed methods.
Conversations
Run a consultation from first turn to completion.
Safety
Handle guardian events and calls to action.
API reference
Every operation, field, and response in the OpenAPI contract.