{
"event_id": "7e1d2c3b-1111-4444-8888-aaaaaaaaaaaa",
"status": "recorded"
}{
"event_id": "7e1d2c3b-1111-4444-8888-aaaaaaaaaaaa",
"status": "recorded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "engine_binding_forbidden",
"message": "API key is not bound to this run's engine"
}{
"code": "run_not_found",
"message": "Run not found"
}{
"code": "event_id_reused",
"message": "event_id was previously used for a different run, engine, event_type, or payload"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "internal_error",
"message": "Internal server error"
}{
"code": "auth_unavailable",
"message": "API key authentication is temporarily unavailable"
}{
"code": "request_timeout",
"message": "Request timed out"
}Submit run outcome
Record what happened after a run: viewed, accepted, overridden, or the final result. Idempotent on event_id.
{
"event_id": "7e1d2c3b-1111-4444-8888-aaaaaaaaaaaa",
"status": "recorded"
}{
"event_id": "7e1d2c3b-1111-4444-8888-aaaaaaaaaaaa",
"status": "recorded"
}{
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}{
"code": "unauthorized",
"message": "Missing or invalid API key"
}{
"code": "engine_binding_forbidden",
"message": "API key is not bound to this run's engine"
}{
"code": "run_not_found",
"message": "Run not found"
}{
"code": "event_id_reused",
"message": "event_id was previously used for a different run, engine, event_type, or payload"
}{
"code": "rate_limited",
"message": "Rate limit exceeded"
}{
"code": "internal_error",
"message": "Internal server error"
}{
"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 /records, /actions, /operations,
/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
Engine identifier slug (e.g. default).
Body
- Option 1
- Option 2
- Option 3
- Option 4
An outcome event of type viewed. Unknown fields are rejected with 400 invalid_request.
A UUID version 4 in its 36-character hyphenated form. Send it in lowercase and repeat it exactly on a retry. Idempotency key, unique per organization and environment bucket. Live keys share one bucket, and test keys, every named sandbox included, share the other.
viewed Payload for viewed. Unknown fields are rejected with 400 invalid_payload.