v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB

/api/v1/ambient/session/{session_id}/{entity}/feedback

Submit ambient session feedback

Submits quantitative and qualitative feedback on AI-generated clinical content for an ambient session. You can submit feedback once per entity type per session.

post/api/v1/ambient/session/{session_id}/{entity}/feedback

Path parameters

session_idstring required

UUID for the ambient session you are rating. Use the same ambient_session_id from Create Ambient Session.

entitystring required

Entity type you are rating. For ambient sessions, use content for generated clinical note content. You can submit feedback once per entity type per session.

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.

Request body

qualitative_commentsstring

Optional - Qualitative feedback comments for detailed insights. Maximum 2000 characters allowed.

Example request

{
  "ratingFeedback": {
    "max_rating": 1,
    "rating": 1
  },
  "qualitative_comments": "The generated content was accurate and helpful"
}

Response

Resource created successfully.

feedback_idstring

Unique identifier for the submitted feedback

Example response

{
  "feedback_id": "fb_abc123def456-789xyz-012uvw"
}