Form Filling Feedback
Form Filling Session Feedback
Submit feedback for a Form filling session entity
Listen to this pageabout 1 min
POST
/
api
/
v1
/
form-filling
/
session
/
{ambient_session_id}
/
{entity}
/
feedback
cURL
curl --request POST \
--url https://sdp.suki.ai/api/v1/form-filling/session/<ambient_session_id>/<entity>/feedback \
--header 'Content-Type: application/json' \
--header 'sdp_suki_token: <sdp_suki_token>' \
--header 'sdp_provider_id: <sdp_provider_id>' \
--data '{
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {
"min_rating": 1,
"max_rating": 5,
"rating": 5
}
},
"feedback_metadata": {
"form_id": "018f94e8-7aa8-7bfd-bc83-046262001234"
}
}'import requests
url = "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback"
payload = {
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {
"min_rating": 1,
"max_rating": 5,
"rating": 5
}
},
"feedback_metadata": { "form_id": "018f94e8-7aa8-7bfd-bc83-046262001234" }
}
headers = {
"sdp_suki_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {sdp_suki_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
feedback: {
qualitative_comments: 'Accurate and well-structured form output.',
ratingFeedback: {min_rating: 1, max_rating: 5, rating: 5}
},
feedback_metadata: {form_id: '018f94e8-7aa8-7bfd-bc83-046262001234'}
})
};
fetch('https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'feedback' => [
'qualitative_comments' => 'Accurate and well-structured form output.',
'ratingFeedback' => [
'min_rating' => 1,
'max_rating' => 5,
'rating' => 5
]
],
'feedback_metadata' => [
'form_id' => '018f94e8-7aa8-7bfd-bc83-046262001234'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"sdp_suki_token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback"
payload := strings.NewReader("{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("sdp_suki_token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback")
.header("sdp_suki_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["sdp_suki_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}"
response = http.request(request)
puts response.read_body{
"feedback_id": "<string>"
}{
"code": 400,
"message": "invalid request"
}{
"code": 401,
"message": "invalid token"
}{
"code": 403,
"message": "forbidden"
}{
"code": 404,
"message": "not found"
}{
"code": 500,
"message": "internal server error"
}Use this endpoint to submit feedback for a Form filling ambient session. This endpoint calls SubmitFormFillingFeedback, which is separate from the ambient SubmitFeedback API.
Requirements
-
ambient_session_idmust reference a Form filling session with the underlying job typeFORM_FILLING_ORCHESTRATION. If the session type does not match, the API returns aFailedPreconditionerror. -
Set
entitytoAMBIENT_GENERATED_MEDICAL_FORMwhen submitting feedback for a generated medical form. -
feedback_metadata.form_idis required whenentityisAMBIENT_GENERATED_MEDICAL_FORM. Pass the generated medical form instance ID. The API uses this ID to load the form details before forwarding the request to the feedback service.
feedback_id. The value matches the provided ambient_session_id, consistent with the ambient feedback API behavior.
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.- Python
- TypeScript
from typing import Any, TypedDict, cast
import requests
BASE_URL = "https://sdp.suki-stage.com"
ENTITY_AMBIENT_GENERATED_MEDICAL_FORM = "AMBIENT_GENERATED_MEDICAL_FORM"
class QuantitativeFeedback(TypedDict, total=False):
max_rating: int
min_rating: int
rating: int
class Feedback(TypedDict, total=False):
qualitative_comments: str
ratingFeedback: QuantitativeFeedback
class FeedbackMetadata(TypedDict):
form_id: str
class FormFillingFeedbackPayload(TypedDict):
feedback: Feedback
feedback_metadata: FeedbackMetadata
class SubmitFeedbackResponse(TypedDict):
feedback_id: str
class ApiHttpError(RuntimeError):
"""Wrong HTTP status; OpenAPI errors usually include JSON with message + code."""
def __init__(self, status: int, url: str, detail: str) -> None:
super().__init__(f"HTTP {status} {url}: {detail}")
self.status = status
self.url = url
def _post_json_expect(url: str, headers: dict[str, str], payload: dict[str, Any], expect_status: int) -> dict[str, Any]:
r = requests.post(url, json=payload, headers=headers, timeout=60)
if r.status_code == expect_status:
data = r.json()
if isinstance(data, dict):
return data
raise ApiHttpError(expect_status, url, "response JSON was not an object")
detail = ""
try:
err = r.json()
if isinstance(err, dict) and isinstance(err.get("message"), str):
detail = err["message"]
except ValueError:
detail = (r.text or "")[:500]
raise ApiHttpError(r.status_code, url, detail or "(no body)")
def submit_form_filling_feedback(
suki_token: str,
ambient_session_id: str,
entity: str,
body: FormFillingFeedbackPayload,
) -> SubmitFeedbackResponse:
"""POST /api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback (sdp_suki_token header required). HTTP 201."""
url = f"{BASE_URL}/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback"
headers = {"sdp_suki_token": suki_token, "sdp_provider_id": "<sdp_provider_id>", "Content-Type": "application/json"}
data = _post_json_expect(url, headers, dict(body), 201)
fid = data.get("feedback_id")
if not isinstance(fid, str) or not fid:
raise ValueError(f"{url}: 201 response missing feedback_id")
return cast(SubmitFeedbackResponse, {"feedback_id": fid})
if __name__ == "__main__":
try:
out = submit_form_filling_feedback(
"YOUR_SUKI_TOKEN",
"YOUR_AMBIENT_SESSION_ID",
ENTITY_AMBIENT_GENERATED_MEDICAL_FORM,
{
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {"min_rating": 1, "max_rating": 5, "rating": 5},
},
"feedback_metadata": {
"form_id": "018f94e8-7aa8-7bfd-bc83-046262001234",
},
},
)
print(out["feedback_id"])
except (ApiHttpError, ValueError) as e:
print(e)
const BASE_URL = "https://sdp.suki-stage.com";
const ENTITY_AMBIENT_GENERATED_MEDICAL_FORM = "AMBIENT_GENERATED_MEDICAL_FORM";
type QuantitativeFeedback = {
max_rating?: number;
min_rating?: number;
rating?: number;
};
type Feedback = {
qualitative_comments?: string;
ratingFeedback?: QuantitativeFeedback;
};
type FeedbackMetadata = {
form_id: string;
};
type FormFillingFeedbackPayload = {
feedback: Feedback;
feedback_metadata: FeedbackMetadata;
};
type SubmitFeedbackResponse = { feedback_id: string };
class ApiHttpError extends Error {
status: number;
url: string;
constructor(status: number, url: string, detail: string) {
super(`HTTP ${status} ${url}: ${detail}`);
this.status = status;
this.url = url;
}
}
async function postJsonExpectObject(
url: string,
headers: Record<string, string>,
body: Record<string, unknown>,
expectStatus: number
): Promise<Record<string, unknown>> {
const res = await fetch(url, { method: "POST", headers, body: JSON.stringify(body) });
const text = await res.text();
const json = text ? JSON.parse(text) : {};
if (res.status !== expectStatus) {
const msg = typeof (json as any)?.message === "string" ? (json as any).message : text?.slice(0, 500) || "(no body)";
throw new ApiHttpError(res.status, url, msg);
}
if (json && typeof json === "object" && !Array.isArray(json)) return json as Record<string, unknown>;
throw new ApiHttpError(res.status, url, "response JSON was not an object");
}
export async function submitFormFillingFeedback(
sukiToken: string,
ambientSessionId: string,
entity: string,
body: FormFillingFeedbackPayload
): Promise<SubmitFeedbackResponse> {
const url = `${BASE_URL}/api/v1/form-filling/session/${ambientSessionId}/${entity}/feedback`;
const data = await postJsonExpectObject(
url,
{ sdp_suki_token: sukiToken, sdp_provider_id: "<sdp_provider_id>", "Content-Type": "application/json" },
body as Record<string, unknown>,
201
);
const feedbackId = data.feedback_id;
if (typeof feedbackId !== "string" || !feedbackId) {
throw new Error(`${url}: 201 response missing feedback_id`);
}
return { feedback_id: feedbackId };
}
// Example usage
const out = await submitFormFillingFeedback("YOUR_SUKI_TOKEN", "YOUR_AMBIENT_SESSION_ID", ENTITY_AMBIENT_GENERATED_MEDICAL_FORM, {
feedback: {
qualitative_comments: "Accurate and well-structured form output.",
ratingFeedback: { min_rating: 1, max_rating: 5, rating: 5 },
},
feedback_metadata: {
form_id: "018f94e8-7aa8-7bfd-bc83-046262001234",
},
});
console.log(out.feedback_id);
Authorizations
Headers
Path Parameters
Body
application/json
Last modified on August 13, 2026
Was this page helpful?
cURL
curl --request POST \
--url https://sdp.suki.ai/api/v1/form-filling/session/<ambient_session_id>/<entity>/feedback \
--header 'Content-Type: application/json' \
--header 'sdp_suki_token: <sdp_suki_token>' \
--header 'sdp_provider_id: <sdp_provider_id>' \
--data '{
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {
"min_rating": 1,
"max_rating": 5,
"rating": 5
}
},
"feedback_metadata": {
"form_id": "018f94e8-7aa8-7bfd-bc83-046262001234"
}
}'import requests
url = "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback"
payload = {
"feedback": {
"qualitative_comments": "Accurate and well-structured form output.",
"ratingFeedback": {
"min_rating": 1,
"max_rating": 5,
"rating": 5
}
},
"feedback_metadata": { "form_id": "018f94e8-7aa8-7bfd-bc83-046262001234" }
}
headers = {
"sdp_suki_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {sdp_suki_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
feedback: {
qualitative_comments: 'Accurate and well-structured form output.',
ratingFeedback: {min_rating: 1, max_rating: 5, rating: 5}
},
feedback_metadata: {form_id: '018f94e8-7aa8-7bfd-bc83-046262001234'}
})
};
fetch('https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'feedback' => [
'qualitative_comments' => 'Accurate and well-structured form output.',
'ratingFeedback' => [
'min_rating' => 1,
'max_rating' => 5,
'rating' => 5
]
],
'feedback_metadata' => [
'form_id' => '018f94e8-7aa8-7bfd-bc83-046262001234'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"sdp_suki_token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback"
payload := strings.NewReader("{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("sdp_suki_token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback")
.header("sdp_suki_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sdp.suki.ai/api/v1/form-filling/session/{ambient_session_id}/{entity}/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["sdp_suki_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"feedback\": {\n \"qualitative_comments\": \"Accurate and well-structured form output.\",\n \"ratingFeedback\": {\n \"min_rating\": 1,\n \"max_rating\": 5,\n \"rating\": 5\n }\n },\n \"feedback_metadata\": {\n \"form_id\": \"018f94e8-7aa8-7bfd-bc83-046262001234\"\n }\n}"
response = http.request(request)
puts response.read_body{
"feedback_id": "<string>"
}{
"code": 400,
"message": "invalid request"
}{
"code": 401,
"message": "invalid token"
}{
"code": 403,
"message": "forbidden"
}{
"code": 404,
"message": "not found"
}{
"code": 500,
"message": "internal server error"
}