Skip to main content
POST
cURL
Updated:You can now send partner-defined custom forms dynamically instead of relying only on pre-existing Suki Medical form templates. Refer to Dynamic Form filling for use cases, XOR rules, and static versus dynamic structured-data fields.
Use this endpoint to provide (seed) for a Form filling session. Add context to improve the structured data returned by Suki when you bind forms. To generate filled form outputs you must seed at least one form in form_filling.values (either a form_template_id or a schema). Suki lets you bind forms in the following ways:
  • Static: A Suki Medical form template (form_template_id) defined in the Suki Medical form templates catalog.
  • Dynamic: Your partner-defined schema object (optional id, name, and type) for your own custom forms.
  • Mixed: Both static and dynamic entry types in the same form_filling.values array in case you need to capture a mix of Suki templates and your own custom forms.
To generate filled form outputs you MUST include form_filling with a non-empty values array in the request body. Each values[] entry must include exactly one of form_template_id or schema (never both) and be otherwise valid.

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

Session context for Form filling. To enable form filling, include at least one entry in form_filling.values; each entry MUST include either form_template_id or schema. Seeding is required to generate filled forms.

form_filling
object

Forms to fill for this session. Required only when you send context.

Response

Request succeeded.

The response is of type object.

Last modified on September 29, 2026