Skip to main content
POST
/
api
/
v1
/
ambient
/
session
/
create
Creates an ambient session.
curl --request POST \
  --url https://sdp.suki-stage.com/api/v1/ambient/session/create \
  --header 'Content-Type: application/json' \
  --header 'sdp_suki_token: <sdp_suki_token>' \
  --data '{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg",
  "encounter_id": "123dfg-456dfg-789dfg-012dfg",
  "multilingual": false
}'
{
  "ambient_session_id": "123dfg-456dfg-789dfg-012dfg"
}

Headers

​
sdp_suki_token
string
required

sdp_suki_token

Body

application/json

CreateSessionRequest

Request body for the /session/create endpoint

​
ambient_session_id
string

Optional - UUID format

Example:

"123dfg-456dfg-789dfg-012dfg"

​
encounter_id
string

Optional - UUID format

Example:

"123dfg-456dfg-789dfg-012dfg"

​
multilingual
boolean

Optional - Boolean to depict if the session is multilingual. Defaults to false if not provided.

Example:

false

Response

Success Response

Response body for the /session/create endpoint

​
ambient_session_id
string
Example:

"123dfg-456dfg-789dfg-012dfg"

⌘I