Skip to main content
PATCH
cURL
Use this endpoint to partially update the for Form filling sessions. Providing detailed context helps Suki generate more accurate structured form output. This is a PATCH operation that allows partial updates to the session context.
The body of this request is optional. However, if you decide to provide context, you must provide valid values for the properties. When you send form_filling, each values[] entry must use exactly one of form_template_id or schema. Refer to Dynamic Form filling.

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"

Path Parameters

ambient_session_id
string
required

Form-filling session ID. The path parameter is named ambient_session_id, but this value identifies the form-filling session, not an ambient clinical documentation session. Use the ID returned from Create Form filling Session, or the UUID you supplied in that request.

Body

application/json

Partial update for Form filling session context. Send only the fields you want to change.

form_filling
object

Updated forms to fill for this session.

Response

Request succeeded.

Response body for the /api/v1/form-filling/session/{ambient_session_id}/context PATCH endpoint

context
object

Updated context for the form-filling session

Last modified on September 29, 2026