Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/api/v1/ambient/session

Creates an ambient session.

Creates a new ambient session for patient encounter documentation. Returns an ambient_session_id to use in context, streaming, status, and content APIs. Both request body fields are optional; Suki generates any values you omit.

post/api/v1/ambient/session/create

Headers

sdp_provider_idstring
Example:provider-123

Optional for standard partners.

Required for:

  • Bearer authentication. Use the same provider_id returned by the Login or Register API.
  • Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Request body

ambient_session_idstring

Optional - UUID for this Ambient session. Suki generates one when omitted and returns it in the response.

emr_encounter_idstring

Optional - UUID for your EMR or EHR visit. Pass this when you want the same Ambient note to work across APIs and SDKs. Required for cross-modality Ambient workflows.

encounter_idstring

Optional - Session group ID that groups Ambient sessions under one note. Pass the same value when you continue or re-ambient a note. Up to 255 characters. If omitted on the first session, Suki generates one.

multilingualboolean

Deprecated. Multilingual support is enabled by default for all Ambient sessions.

Example request

{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg",
  "emr_encounter_id": "123dfg-456dfg-789dfg-012dfg",
  "encounter_id": "123dfg-456dfg-789dfg-012dfg"
}

Response

Resource created successfully.

ambient_session_idstring

UUID for the created Ambient session. Store this for later session API calls.

composition_idstring

ID of the note for this session. Pass this value as note_id when you call the note-level Ambient APIs.

Example response

{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg",
  "composition_id": "123dfg-456dfg-789dfg-012dfg"
}