Skip to main content
POST
/
api
/
v1
/
engines
/
{engine_slug}
/
runs
/
{run_id}
/
annotations
Annotate a Run
curl --request POST \
  --url https://api.usenexio.com/api/v1/engines/{engine_slug}/runs/{run_id}/annotations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "comment": "Bound the recommended carrier; the ranking matched our judgment.",
  "target": {},
  "submitter_id": "<string>",
  "time_on_task_seconds": 123
}
'
{
  "id": "<string>",
  "run_id": "<string>",
  "rating": "<string>",
  "comment": "<string>",
  "source": "api",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key with environment prefix. Use nx_test_... for sandbox and nx_live_... for production. Obtain keys at platform.usenexio.com/settings/api-keys.

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. Cannot be empty.

Example:

"Bound the recommended carrier; the ranking matched our judgment."

​
target
object

Optional pointer at the output element the note is about.

​
submitter_id
string | null

Optional caller-supplied identifier for who submitted the signal.

​
time_on_task_seconds
integer | null

Response

Annotation recorded.

​
id
string
​
run_id
string
​
rating
string
​
comment
string
​
source
string
Example:

"api"

​
created_at
string<date-time>