# Doctronic API

- [Overview](/docs): Use the Doctronic API to run clinical conversations, handle events, book care, and retrieve consultation documents.

- **Get started**
- [Choose an integration pattern](/docs/integration-patterns): Understand which workflows use the public API, which require configuration, and which are designed with Doctronic.
- [Access and environments](/docs/access-and-environments): Request credentials and keep staging and production integrations isolated.
- [Make your first request](/docs/getting-started): Create a user, run a clinical consultation, and retrieve its consultation documents.
- [Authentication](/docs/authentication): Authenticate your organization and scope requests to the correct Doctronic user.

- **Build**
- Clinical conversations
  - [Consultation lifecycle](/docs/conversations/lifecycle): Understand how users, chats, messages, events, and artifacts fit together.
  - [Stream chat responses](/docs/conversations/streaming): Consume Server-Sent Events safely and preserve forward compatibility.
- [Patient context and handoffs](/docs/patient-context-and-handoffs): Pass relevant context into a conversation while keeping identity, authorization, and routing in trusted backend code.
- [Appointments](/docs/appointments): Find availability and book, inspect, cancel, or reschedule care.
- [Consultation documents](/docs/clinical-artifacts): Retrieve long summaries, short summaries, and SOAP notes after consultation completion.
- [Webhooks](/docs/webhooks): Receive signed appointment and consultation-document updates at an HTTPS endpoint configured by Doctronic.
- [Patient experience](/docs/patient-experience): Build a patient-facing flow around the API without exposing credentials or inferring workflow state from text.
- Integration guides
  - [Guides overview](/docs/guides): Connect API operations into complete conversation, care, safety, and testing workflows.
  - [Build a clinical conversation](/docs/guides/embed-clinical-intelligence): Connect an authenticated user to a streamed conversation, typed events, and consultation documents.
  - [Guide patients to care](/docs/guides/guide-patients-to-care): Turn explicit conversation events into scheduled or ASAP appointment workflows.
  - [Handle safety and escalation](/docs/guides/safety-and-escalation): Build explicit, forward-compatible behavior for safety and workflow events.
  - [Test your integration](/docs/guides/test-your-integration): Validate identity scoping, event handling, artifacts, and care workflows before production.

- **Safety and trust**
- [Safety and responsibilities](/docs/safety-and-responsibilities): Separate Doctronic's clinical event contract from the behavior owned by your product.
- [Evaluation approach](/docs/evaluation): Define evidence for clinical quality, safety behavior, and integration correctness before launch.
- [Security and privacy](/docs/security-and-privacy): Protect API credentials, patient identity, clinical content, and operational records in your integration.

- **Operate**
- [Implementation and rollout](/docs/implementation-and-rollout): Move from a defined workflow to staging validation and controlled production traffic.
- [Production readiness](/docs/production-readiness): Review authentication, streaming, safety, retries, and operations before launch.
- [Errors, idempotency, and retries](/docs/errors): Handle HTTP failures, stream errors, idempotent mutations, and uncertain outcomes.
- [Versioning and support](/docs/versioning-and-support): Build for additive API changes and provide the details needed to investigate a problem.

- **Resources**
- [Docs for coding tools](/docs/agent-resources): Load the OpenAPI contract or plain-text documentation into coding and validation tools.
- API reference
  - [API overview](/docs/api-reference): The complete OpenAPI 3.1 contract for the Doctronic API.
  - Endpoints
    - Users: Create and retrieve users in your organization.
      - [Users](/docs/api-reference/endpoints/users): Create and retrieve users in your organization.
      - [Get user details](/docs/api-reference/endpoints/users/get-users): Retrieve the user account for the authenticated organization.
      - [Create a user](/docs/api-reference/endpoints/users/post-users): Create a user inside the organization identified by the Bearer token.
    - Chats: Create conversations, send messages, and consume streaming clinical responses.
      - [Chats](/docs/api-reference/endpoints/chats): Create conversations, send messages, and consume streaming clinical responses.
      - [List chats](/docs/api-reference/endpoints/chats/get-chats): List chats available to the authenticated organization and user scope.
      - [Create a chat](/docs/api-reference/endpoints/chats/post-chats): Create a chat for the user identified by `X-Doctronic-User-ID` within the organization identified by the Bearer token.
      - [Get a chat](/docs/api-reference/endpoints/chats/get-chats-chat-id): Fetch a single chat by id.
      - [List chat messages](/docs/api-reference/endpoints/chats/get-chats-chat-id-messages): List the user and assistant messages in a chat.
      - [Stream a chat turn (SSE)](/docs/api-reference/endpoints/chats/post-chats-chat-id-stream): Send a user message to an existing chat and stream the assistant's reply as Server-Sent Events.
    - Appointments: Find availability and manage scheduled or ASAP appointments.
      - [Appointments](/docs/api-reference/endpoints/appointments): Find availability and manage scheduled or ASAP appointments.
      - [List available scheduled appointment slots](/docs/api-reference/endpoints/appointments/get-appointments-scheduled-available-slots): Returns available appointment start times filtered to practitioners credentialed in the provided US state.
      - [Book a scheduled appointment](/docs/api-reference/endpoints/appointments/post-appointments-scheduled): Creates a scheduled appointment for a specific future time slot. The slot must be one returned by GET /appointments/scheduled/available-slots/ for the provided location.state.
      - [Book an ASAP appointment](/docs/api-reference/endpoints/appointments/post-appointments-asap): Places the patient in a shared waiting room immediately. A practitioner credentialed in the given state will join when available: there is no guaranteed wait time.
      - [List appointments](/docs/api-reference/endpoints/appointments/get-appointments): List appointments for the user identified by `X-Doctronic-User-ID` within the authenticated organization.
      - [Get appointment details](/docs/api-reference/endpoints/appointments/get-appointments-appointment-id): Fetch a single appointment by id
      - [Cancel appointment](/docs/api-reference/endpoints/appointments/post-appointments-appointment-id-cancel): Cancel a booked appointment
      - [Reschedule appointment](/docs/api-reference/endpoints/appointments/post-appointments-appointment-id-reschedule): Reschedule a booked appointment to a new time slot
    - Address: Set the address used for care availability and fulfillment.
      - [Address](/docs/api-reference/endpoints/address): Set the address used for care availability and fulfillment.
      - [Get a user's address](/docs/api-reference/endpoints/address/get-address): Retrieve the address currently on file for the authenticated user.
      - [Set a user's address](/docs/api-reference/endpoints/address/put-address): Create or replace the address on file for the authenticated user (upsert).
    - Pharmacy: Search for and select a user pharmacy.
      - [Pharmacy](/docs/api-reference/endpoints/pharmacy): Search for and select a user pharmacy.
      - [Search pharmacies](/docs/api-reference/endpoints/pharmacy/post-pharmacy-search): Search pharmacies by name, with optional proximity or state filtering.
      - [Set a user's pharmacy](/docs/api-reference/endpoints/pharmacy/put-pharmacy): Save or replace the authenticated user's preferred pharmacy.
    - Artifacts: Retrieve consultation summaries and clinical documents.
      - [Artifacts](/docs/api-reference/endpoints/artifacts): Retrieve consultation summaries and clinical documents.
      - [Get a consultation artifact](/docs/api-reference/endpoints/artifacts/get-artifacts-artifact-id): Retrieve a consultation artifact by the stable identifier delivered in the `ai_consultation.complete` stream event.