SUsuki
/api/v1/ambient/session

Creates an ambient session.

Changed on

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

Request

  • Base URL
    https://sdp.suki.ai
  • URL
    https://sdp.suki.ai/api/v1/ambient/session/create
  • Auth
    API key in header sdp_suki_token

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 for standalone sessions - Visit interop key for interoperability. Accepts a UUID or non-UUID value, at most 36 characters. One EMR encounter can contain multiple notes. Required for cross-modality Ambient workflows.

encounter_idstring

Optional - Groups re-ambient sessions for one note. Pass it on the first session and reuse the same value on later creates. If the first create omitted it, pass the returned note_id as this field's value for re-ambient. There is no separate note_id request field. Up to 255 characters. Create does not return this field.

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.

note_idstring

ID of the clinical note for this session. Use it as the note_id path parameter on note-level Ambient APIs (note content, note context, note structured data). If the first create omitted encounter_id, pass this value as the encounter_id field on later creates to re-ambient the same note.

composition_idstring

Deprecated. Same value as note_id. Kept for backward compatibility. Prefer note_id.

Example response

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

Changes

  • 2181be71d4ddRevision changes
    • warning

      the request property's maxLength was set to 36

    • info

      added the optional property to the response with the status

    • info

      response property composition_id deprecated