v1
latestOpenAPI 3.0.12026-07-2649123153.6 KB/api/v1/form-filling/session
End form-filling session
Ends a form-filling session and triggers structured form output generation.
post/api/v1/form-filling/session/{ambient_session_id}/end
Path parameters
ambient_session_idstring 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.
Headers
sdp_provider_idstring
Example:provider-123
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.
Response
Request succeeded.
object required