API reference
Quality
1 operations. Base URL: https://api.ringura.com/api/v1. Authenticate with a bearer token that carries the scope named on each operation.
GET /api/v1/qa/evaluations
Human QA evaluations, newest first (drafts included).
Parameters
| Name | In | Type | Required | Constraints |
|---|---|---|---|---|
agentId | query | string (uuid) | No | |
status | query | string | No | one of "draft", "submitted", "acknowledged", "disputed", "upheld", "revised" |
Response
200 JSON with these fields.
| Field | Type | Required | Constraints |
|---|---|---|---|
data | array of object | Yes | |
data[].id | string (uuid) | Yes | |
data[].formId | string (uuid) | Yes | |
data[].conversationId | string (uuid) | Yes | |
data[].agentId | string (uuid) | Yes | |
data[].evaluatorUserId | string (uuid) | Yes | |
data[].planId | string (uuid) or null | Yes | |
data[].calibrationId | string (uuid) or null | Yes | |
data[].answers | object | Yes | free-form object |
data[].scoreBp | integer or null | Yes | |
data[].criticalFailed | boolean | Yes | |
data[].status | string | Yes | |
data[].comment | string or null | Yes | |
data[].submittedAt | string (date-time) or null | Yes | |
data[].acknowledgedAt | string (date-time) or null | Yes | |
data[].version | integer | Yes | |
data[].createdAt | string (date-time) | Yes |
Errors
400, 401, 403, 404, 409, 429. What each status means
Example request
curl -X GET 'https://api.ringura.com/api/v1/qa/evaluations' \
-H "Authorization: Bearer $CC_TOKEN"