Skip to main content

Annotations

POST/v1/orgs/{org_id}/annotations/export

Export Annotations

Export annotated traces to an evaluation dataset.

CI or Admin tokenscope: writeoperation_id: annotations.export

Authentication

Requires a CI- or admin-level token. Runtime tokens are rejected for mutations.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Request bodyrequired

FieldTypeRequiredDescription
annotation_typestringrequiredAnnotation type to export (e.g. false_positive)
dataset_idstringrequiredTarget dataset ID

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

any

Errors & what triggers them

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

Request

curl -X POST 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/annotations/export' \
  -H 'Authorization: Bearer $ZNYX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "annotation_type": "string",
  "dataset_id": "string"
}'

Response

application/json

Successful Response

null

Schema: any