Create Annotation

Annotate a trace as false positive, false negative, correct, or acceptable.

Bearer token or X-API-Keyscope: org memberoperation_id: annotations.create

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X POST "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/traces/00000000-0000-0000-0000-000000000000/annotations" \
  -H "Authorization: Bearer $ZNYX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "annotation": "string",
  "detector_name": null,
  "notes": null,
  "annotated_by": null
}'

Response

application/json

Successful Response

{
  "id": "string",
  "trace_id": "string",
  "annotation": "string",
  "detector_name": null,
  "notes": null,
  "annotated_by": null,
  "created_at": null
}

Schema: object

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-
trace_id#path	string	required	-

Header parameters

Name	Type	Required	Description
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Request bodyrequired

Field	Type	Required	Description
annotation	string	required	false_positive, false_negative, correct, or acceptable
detector_name	string \| null	optional	-
notes	string \| null	optional	-
annotated_by	string \| null	optional	-

Responses

Status	Description
200	Successful Response
422	Validation Error

Response schema

idrequiredstring

trace_idrequiredstring

annotationrequiredstring

detector_namestring | null

notesstring | null

annotated_bystring | null

created_atstring | null

Errors & what triggers them

Code	Trigger	Fix
401	Missing or expired Authorization header.	-
403	Token does not have the required role (admin / editor).	-
404	Target resource does not exist in this org.	-
422	Request body failed validation.	-