Skip to main content
POST
cURL
Use this endpoint to create a Form filling ambient session. Suki will return a Form filling ambient session identifier (id) in response for subsequent calls. You must use the returned session identifier (id) to perform other operations for that session for example checking session status, retrieving structured data, submitting feedback, ending the session, and more.
Important:In the documentation, both the Form filling session ID and the Suki Ambient API session ID are referred to as ambient_session_id. However, these are two different identifiers and should not be treated as the same value.

Code examples

The code examples below use placeholders and the stage host sdp.suki-stage.com only as examples. For credentials, base URLs, where to run Python or TypeScript, CORS, and cURL, refer to Using code examples in your integration in the API Reference Guidelines.

Authorizations

sdp_suki_token
string
header
required

Suki access token (suki_token) from Login or Register. Expires after one hour.

Headers

sdp_provider_id
string

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.
Example:

"provider-123"

Body

application/json

Optional form-filling session ID and correlation metadata. Suki generates a form-filling session ID when omitted.

ambient_session_id
string

Optional - Form-filling session ID in UUID format. Suki generates one when omitted and returns it in the ambient_session_id response field. Do not pass an ambient clinical documentation session ID.

Example:

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

correlation_id
string

Optional - Client-supplied identifier for tracing or correlating requests.

Example:

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

Response

Resource created successfully.

New form-filling session ID returned after create.

ambient_session_id
string

Form-filling session ID for subsequent form-filling API calls. Despite the field name, this is not an ambient clinical documentation session ID.

Example:

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

Last modified on August 13, 2026