get
https://partner.gupshup.io/partner/app//bizai/agent-eval/cases
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request parameters
| Parameter | Type | Required | In | Description |
|---|---|---|---|---|
Authorization | string | Yes | Header | Partner app token, sent raw. Bearer <token> is also accepted. |
appId | string (uuid) | Yes | Path | Partner Portal app id. Stands in for Meta's entity_id. |
Example request
curl --location --request GET 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent-eval/cases' \
--header 'Authorization: <PARTNER_APP_TOKEN>'Response parameters — 200
200| Parameter | Type | Description |
|---|---|---|
eval_cases | array of object | Evaluation cases. |
eval_cases[].id | string | Resource id. Meta pfbid… id. |
eval_cases[].scenario | string | What the simulated consumer tries to do. |
eval_cases[].scenario_version | string | Version of the scenario. |
eval_cases[].categories | array of string | Case categories. |
eval_cases[].max_turns | integer | Maximum conversation turns. |
eval_cases[].success_criteria | array of string | What counts as a pass. |
Example response — 200 OK
200 OK{
"eval_cases": [
{
"id": "pfbid0EvalCaseExampleId",
"scenario": "Customer asks for a refund on a delayed order",
"scenario_version": "1",
"categories": ["refunds"],
"max_turns": 6,
"success_criteria": ["Agent confirms the refund amount"]
}
]
}Error responses
400 Bad Request — The app is not live, or WASS does not consider it live.
{
"message": "App is not live.",
"status": "error"
}400 Bad Request — The app has no phone number attached. Checked before the live check.
{
"message": "Phone id not found for the given App",
"status": "error"
}401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.
{
"status": "error",
"message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.
{
"status": "error",
"message": "Request method 'PATCH' is not supported"
}429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.
{
"status": "error",
"message": "Too Many Requests"
}Per-app rate limit exceeded. Retry after the 60-second window.