Query feedback¶
Filter run feedback reviewable by the current user by Agent, Context, Task, Message, or Rating.
GET $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/feedback
Before you call this API¶
Configure the regional API endpoint and authentication, and select the target workspace.
If you need to filter by agent, first obtain the agent ID.
Set the operation-specific values used in the request:
$AGENT_ID: Optional agent filter ID.
Request¶
curl --get "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/feedback" \
-H "X-API-Key: $CLOUDSIGMA_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
--data-urlencode "agent_id=$AGENT_ID" \
--data-urlencode "rating=positive" \
--data-urlencode "limit=20"
Path parameters
Parameters |
Type |
Is it required |
Description |
|---|---|---|---|
|
string |
Yes |
The current workspace ID. |
Query parameters
Parameters |
Type |
Is it required |
Description |
|---|---|---|---|
|
string |
No |
Filter by agent ID. |
|
string |
No |
The workspace to which the agent belongs. |
|
string |
No |
Filter by A2A context ID. |
|
string |
No |
Filter by task ID. |
|
string |
No |
Filter by message ID. |
|
string |
No |
Filter by rating. |
|
integer |
No |
Returns the upper limit of quantity. |
|
integer |
No |
Returns the offset. |
Successful response¶
Returns 200 on success.
{
"code": 0,
"data": {
"items": [
{
"id": "fb_01",
"workspace_id": "ws_01",
"agent_id": "agent_01",
"context_id": "ctx_01",
"task_id": "task_01",
"message_id": "msg_01",
"rating": "up",
"intent": "quality",
"labels": [],
"created_by": "user_01",
"created_at": "2026-01-02T15:04:05Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
}
The response fields are as follows.
Field |
Type |
Description |
|---|---|---|
|
integer |
|
|
array |
Feedback record list. |
|
string |
Feedback ID. |
|
string |
Belonging workspace and agent ID. |
|
string |
Belonging workspace and agent ID. |
|
string |
The associated context, task, and message ID. |
|
string |
The associated context, task, and message ID. |
|
string |
The associated context, task, and message ID. |
|
string |
Associated product or tool call ID. |
|
string |
Associated product or tool call ID. |
|
integer |
Message fragment index; only returned if there is a value. |
|
string |
Rating and feedback intent. |
|
string |
Rating and feedback intent. |
|
string |
Feedback description; only returned if there is a value. |
|
string[] |
Feedback tag; only returned if there is a value. |
|
string |
Creator and creation time. |
|
string |
Creator and creation time. |
|
integer |
The total number of filter results, the current return upper limit and offset. |
|
integer |
The total number of filter results, the current return upper limit and offset. |
|
integer |
The total number of filter results, the current return upper limit and offset. |
[] after a type denotes an array. [] in a field path denotes each item in an array.
Error response¶
{
"code": 2,
"message": "反馈筛选条件无效"
}
Common HTTP errors¶
HTTP status code |
error code |
Common causes |
Recommended actions |
|---|---|---|---|
|
|
The resource ID, rating, or paging parameters are invalid. |
Check path and query parameters. |
|
|
Credentials are missing or invalid. |
Check API Key. |
|
|
Current identity cannot read workspace feedback. |
Use valid credentials, or contact your administrator for authorization. |
|
|
Feedback review service is unavailable. |
Try again later. |
Follow-up operations¶
Use the same filter condition Query feedback statistics.