curl --request GET \
--url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"suite": "gate",
"status": "running",
"triggered_by": "publish",
"pass_count": 123,
"fail_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"version": "<string>",
"error": "<string>"
}
]
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "auth_unavailable",
"message": "API key authentication is temporarily unavailable"
}{
"code": "request_timeout",
"message": "Request timed out"
}List eval runs
List an instance’s eval runs, newest first, optionally for one suite.
curl --request GET \
--url https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.usenexio.com/api/v1/conversation-instances/{instance_slug}/eval-runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"runs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"suite": "gate",
"status": "running",
"triggered_by": "publish",
"pass_count": 123,
"fail_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"version": "<string>",
"error": "<string>"
}
]
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "auth_unavailable",
"message": "API key authentication is temporarily unavailable"
}{
"code": "request_timeout",
"message": "Request timed out"
}Authorizations
Send the key as Authorization: Bearer <key>. Two kinds of key exist.
Organization keys are issued in the portal (Settings, then API keys),
each bound to one environment, shaped nx_<environment slug>_<64 hex>. They carry
no capabilities and pass every capability check, with one exception:
routes under /api/v1/records, /api/v1/engines/{id}/opportunities,
/api/v1/graph and /api/v1/catalog/documents accept an
organization key only when its environment is live, and refuse any
other with 403 scoped_key_required. Revocation takes effect within 60
seconds.
Scoped keys are issued by Nexio on request, shaped
nxsk_v1_<24 hex key id>_<43 character secret>. Each is bound to one
org, one environment, a set of engines and a set of capabilities. A
malformed, unknown or revoked nxsk_ key fails with 401 and is never
retried as an organization key. Revocation takes effect on the next
request. A scoped key without a route's capability gets 403
insufficient_capability; a scoped key not bound to the engine gets 403
engine_binding_forbidden.
Key-grantable capabilities: engines:read, runs:write, runs:read,
runs:defensibility:read, runs:test, catalog:read,
catalog:documents:read, webhooks:manage, conversations:use,
conversations:export, records:read, records:opportunities:run,
actions:write, actions:read, graph:read, records:analyze.
Routes that accept organization keys only (every scoped key gets 403
insufficient_capability): environment management, engine create,
update, configuration and publish, and conversation instance
authoring. Each operation description names the capability a scoped
key needs.
Path Parameters
Conversation instance identifier slug (e.g. platform-assistant).
Query Parameters
Only runs of this suite.
gate, workflows, adversarial, smoke 1 <= x <= 200Response
Runs, newest first.
Hide child attributes
Hide child attributes
gate, workflows, adversarial, smoke running while queued or executing. On an on-demand run, passed
when every scenario passed and failed when at least one failed.
On a publish gate run, passed means no regression against the
prior version's run (a first gate run, or failures that were
already failing, still pass; read fail_count), and failed
means a scenario newly fails or a new scenario fails. waived for a publish
gate run whose regression was waived; error when the run cannot
complete: at once for a permanent failure (the instance, its
archived configuration, a stored scenario, or the eval executor is
unavailable or unreadable), or after 5 attempts when execution
failed transiently each time.
running, passed, failed, waived, error publish, manual, schedule, event The released instance version the run measured, as an integer string (for example "4"). Absent when not recorded.
Why the run ended in error. Absent otherwise.