Add clinical conversations to your product.

Use the API to create patients, stream clinical conversations, handle safety and workflow events, book care, and retrieve consultation summaries and SOAP notes.

Run the quickstart View API reference
OpenAPI 3.1 Typed SSE events Organization-scoped access

API workflow

SSE connected
  1. POST /chats/Open a clinical conversationAttach patient and product context.
  2. POST /chats/{chatId}/stream/Start a streamed consultationOpen the typed SSE event stream.
  3. message.contentRender the conversationAppend assistant content as it arrives.
  4. ai_consultation.completeReceive stable artifact IDsRetrieve clinical artifacts when they are ready.

Conditional workflow signals

guardianSafety signalIf emitted, follow the safety behavior approved for your integration.
skill_code.ctaCare actionIf emitted, map it to a supported product action.
event: ai_consultation.completeartifact ids
data: {
  "type": "ai_consultation.complete",
  "artifacts": {
    "longSummary": "art_...",
    "shortSummary": "art_...",
    "soapNote": "art_..."
  }
}

What the API supports.

Use the public API for patient, conversation, appointment, pharmacy, and consultation document operations. Doctronic configures webhooks and implementation-specific routing.

Run a clinical conversation

Create a patient and chat, stream assistant responses, and restore the transcript.

Read the guide

Connect patients to care

Handle next-step events, appointments, pharmacies, and consultation documents.

Read the guide

Handle safety events

Keep guardian, conversation, error, and completion events separate from assistant text.

Read the guide

Get from access to production.

Doctronic provisions credentials. The docs cover implementation, testing, evaluation, operations, and a controlled production rollout.

  1. 01Request accessChoose an environment and request an organization token from Doctronic.
  2. 02Run the quickstartCreate a patient, stream a consultation, and retrieve a consultation document.
  3. 03Prepare for productionValidate isolation, safety handling, retries, observability, and rollout behavior.

Use the same contract in code and documentation.

The API reference is generated from the production OpenAPI contract. Markdown pages and consolidated text indexes are available for coding tools.

API reference OpenAPI JSON Agent index