curl --request POST \
--url 'https://api.example.com/api/response/review' \
--header 'x-widget-token: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"orgId": "string",
"agentId": "string",
"limit": 1,
"includeRecords": true
}'
{
"ok": true,
"generatedAt": "2026-07-24T12:00:00Z",
"orgId": "string",
"agentId": "string",
"limit": 1,
"analysis": {
"summary": {
"total": 1,
"working": 1,
"watch": 1,
"needsImprovement": 1,
"averageScore": 1
},
"intents": [
{
"intent": null,
"total": null,
"averageScore": null
}
],
"suggestions": [
{
"intent": null,
"issue": null,
"recommendation": null,
"ruleDraft": null,
"exampleDrafts": null
}
],
"workingExamples": [
{
"customerMessage": null,
"agentResponse": null
}
],
"regressionCases": [
{
"message": null,
"expectedBehavior": null
}
]
}
}
Review saved responses (POST form)
Review saved responses (POST form)
POST
/
api
/
response
/
review
curl --request POST \
--url 'https://api.example.com/api/response/review' \
--header 'x-widget-token: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"orgId": "string",
"agentId": "string",
"limit": 1,
"includeRecords": true
}'
{
"ok": true,
"generatedAt": "2026-07-24T12:00:00Z",
"orgId": "string",
"agentId": "string",
"limit": 1,
"analysis": {
"summary": {
"total": 1,
"working": 1,
"watch": 1,
"needsImprovement": 1,
"averageScore": 1
},
"intents": [
{
"intent": null,
"total": null,
"averageScore": null
}
],
"suggestions": [
{
"intent": null,
"issue": null,
"recommendation": null,
"ruleDraft": null,
"exampleDrafts": null
}
],
"workingExamples": [
{
"customerMessage": null,
"agentResponse": null
}
],
"regressionCases": [
{
"message": null,
"expectedBehavior": null
}
]
}
}
Request body
ReviewRequest
string
required
string
required
number
boolean
Per-response scores and signals, for debugging
Response
ReviewResponse
boolean
string (date-time)
string
string
number
object
The endpoint does not change rules or examples; promote approved drafts yourself.
Show analysis
Show analysis
Status codes
| Code | Meaning |
|---|---|
200 | OK |
400 | Error |
401 | Error |
curl --request POST \
--url 'https://api.example.com/api/response/review' \
--header 'x-widget-token: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"orgId": "string",
"agentId": "string",
"limit": 1,
"includeRecords": true
}'
{
"ok": true,
"generatedAt": "2026-07-24T12:00:00Z",
"orgId": "string",
"agentId": "string",
"limit": 1,
"analysis": {
"summary": {
"total": 1,
"working": 1,
"watch": 1,
"needsImprovement": 1,
"averageScore": 1
},
"intents": [
{
"intent": null,
"total": null,
"averageScore": null
}
],
"suggestions": [
{
"intent": null,
"issue": null,
"recommendation": null,
"ruleDraft": null,
"exampleDrafts": null
}
],
"workingExamples": [
{
"customerMessage": null,
"agentResponse": null
}
],
"regressionCases": [
{
"message": null,
"expectedBehavior": null
}
]
}
}