Skip to main content
POST
cURL
Use this endpoint to provide (seed) the for Form filling sessions. Providing detailed context helps Suki generate a more accurate and relevant .
The body of this request is optional. However, if you decide to provide context, you must provide valid values for the properties.

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"

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

Form template metadata for the form-filling session, including form_filling.values with required form_template_id entries.

form_filling
object

Optional - Form template metadata for the form-filling session, including required form_template_id values.

Response

Request succeeded.

The response is of type object.

Last modified on August 13, 2026