Skip to main content
POST
Annotate a Run

Authorizations

Authorization
string
header
required

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_slug
string
required

Engine identifier slug (e.g. default).

run_id
string<uuid>
required

Body

application/json
rating
enum<string>
required
Available options:
good,
bad,
neutral
comment
string
required

Required free-text note with at least one non-whitespace character.

Minimum string length: 1
Example:

"The recommendation matched our own review of this supplier."

target
object | null

Optional pointer at the output element the note is about. Any JSON object.

submitter_id
string | null

Optional caller-supplied identifier for who submitted the signal.

time_on_task_seconds
integer | null

Seconds the person spent reviewing.

Required range: 0 <= x <= 86399

Response

Annotation recorded.

id
string<uuid>
required
org_id
string
required
run_id
string<uuid>
required
rating
enum<string>
required
Available options:
good,
bad,
neutral
comment
string
required
source
string
required
Example:

"api"

created_at
string<date-time>
required

Microsecond precision.

updated_at
string<date-time>
required
target
object | null
submitter_id
string
time_on_task_seconds
integer
Last modified on September 25, 2026