{
"status": 400,
"title": "Invalid request parameters",
"detail": "The 'name' field is required and must be a non-empty string.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}
{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}
{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}
{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}
{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}
{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}
Annotation Queues
Annotate a record
Submit annotations for an annotation queue record.
Annotations are upserted into the underlying data source by annotation config name.
Omitted annotation configs are left unchanged.
Payload Requirements
annotations must contain at least one entry and at most 500.
Each annotation name must match an annotation config associated with the queue.
Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written.
Response
Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only.
Evaluations and user assignments are not included for performance reasons.
Use the list records endpoint to retrieve the full record state.
{
"status": 400,
"title": "Invalid request parameters",
"detail": "The 'name' field is required and must be a non-empty string.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request"
}
{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}
{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}
{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}
{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}
{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}
Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format
Annotations to upsert on this record, keyed by annotation config name. At most 500 annotations may be submitted per request ā one per annotation config associated with the queue.
Required array length: 1 - 500 elements
Show child attributes
Response
Returns a snapshot of the record fields updated by the annotate operation. Only the submitted annotations are included. Evaluations and user assignments are omitted; use the list records endpoint for the full record state.
A snapshot of the annotation queue record fields that were modified by an annotate operation. Only the record identity fields and the submitted annotations are returned. Evaluations and user assignments are not fetched and are not included in this response for performance reasons; use the list records endpoint to retrieve the full record state.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Arize AX Docs","colors":{"primary":"#7A0047","light":"#FF8AC8","dark":"#FF74BF"},"logo":{"light":"https://mintcdn.com/arize-ax/V-uvingrGLOCK4VD/logo/light.svg?fit=max\u0026auto=format\u0026n=V-uvingrGLOCK4VD\u0026q=85\u0026s=cc58ee9388d5b5253d39b65cc662908f","dark":"https://mintcdn.com/arize-ax/V-uvingrGLOCK4VD/logo/dark.svg?fit=max\u0026auto=format\u0026n=V-uvingrGLOCK4VD\u0026q=85\u0026s=b16a0266f5913934131301a1b60af51e","href":"https://arize.com"},"favicon":"https://mintcdn.com/arize-ax/1gcABHkqP5TIGbru/favicon.ico?fit=max\u0026auto=format\u0026n=1gcABHkqP5TIGbru\u0026q=85\u0026s=aef538e87b54a3c819583bc40acfc2f8","appearance":{"default":"dark"},"background":{"color":{"light":"#FFFFFF","dark":"#0A0A12"}},"navbar":{"links":[],"primary":{"type":"button","label":"Get started","href":"https://app.arize.com/auth/join"}},"footer":{"socials":{"x":"https://x.com/arizeai","bluesky":"https://bsky.app/profile/arize.bsky.social","threads":"https://www.threads.com/@arize.ai","instagram":"https://www.instagram.com/arize_ai","linkedin":"https://www.linkedin.com/company/arizeai","youtube":"https://youtube.com/@arizeai","slack":"https://arize-ai.slack.com/ssb/redirect","website":"https://fosstodon.org/@arizeai"},"links":[{"header":"Support","items":[{"label":"Chat Us On Slack","href":"https://arize-ai.slack.com/ssb/redirect"},{"label":"support@arize.com","href":"mailto:support@arize.com"},{"label":"System Status","href":"https://status.arize.com"}]},{"header":"Get Started","items":[{"label":"Signup For Free","href":"https://arize.com/join"},{"label":"Book A Demo","href":"https://arize.com/request-a-demo"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://arize.com/blog"}]}]},"seo":{"metatags":{"canonical":"https://arize.com/docs"},"indexing":"all"},"fonts":{"heading":{"family":"Geist","weight":600},"body":{"family":"Geist"}},"styling":{"codeblocks":{"theme":{"light":"github-light-default","dark":"github-dark-default"}},"latex":true},"integrations":{"gtm":{"tagId":"GTM-W96XM35"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"arize-ax","hasAudioNarration":false,"actualSubdomain":"arize-ax","customDomains":[],"gitSource":{"type":"github","owner":"arize-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"contextualFeedback":{"allowEmail":true,"emailDisclaimer":"We will only use your email to follow up with you about this feedback."}},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2624cfeaa11ea2e87f343","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"APIs, SDKs, Skills \u0026 MCP","count":369},{"language":"default","tag":"Get Started","count":250},{"language":"default","tag":"API reference","count":214},{"language":"default","tag":"REST","count":181},{"language":"default","tag":"Endpoints","count":178},{"language":"default","tag":"API clients","count":143},{"language":"default","tag":"Machine Learning","count":139},{"language":"default","tag":"ML observability","count":139},{"language":"default","tag":"Integrations","count":129},{"language":"default","tag":"Python SDK","count":67}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@arize.com"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6944513fe59e82150b5700b3","deploymentId":"6894ef048eafbd2a7c20796e","questionText":"Need more help? Ask our team in #arize-ax-platform-support on community Slack.","status":"active","generatedBy":"manual","createdAt":"2025-12-18T19:08:47.802Z","updatedAt":"2025-12-18T19:15:01.436Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nhtml:root{--font-family-mono-custom: 'Geist Mono'}html:root{--gray-50: 248 248 246;--gray-100: 242 242 237;--gray-200: 230 230 223;--gray-300: 205 205 200;--gray-400: 179 179 191;--gray-500: 138 138 150;--gray-600: 91 91 105;--gray-700: 62 62 78;--gray-800: 46 46 61;--gray-900: 21 21 31;--gray-950: 10 10 18}html:root{--ax-radius-sm: 2px;--ax-radius-md: 6px;--ax-radius-lg: 8px;--ax-accent-bg: #FF74BF;--ax-panel: #CDBEF7;--ax-panel-2: #E3DBFC;--ax-panel-code: #FFFFFF;--ax-panel-border: rgba(19, 22, 64, 0.22);--ax-panel-icon: #4827C1;--ax-panel-t1: #121221;--ax-panel-t2: #2A2A38;--ax-panel-accent: #6E1046;--ax-panel-code-kw: #3F4110;--ax-panel-code-flag: #5A3200;--ax-panel-code-url: #004A70;--ax-panel-selection: #FFE9F4}html:not(.dark){--ax-bg: #FFFFFF;--ax-surface: #F8F8F4;--ax-code-bg: #F5F5ED;--ax-chip: #EDEDE2;--ax-line: rgba(19, 22, 64, 0.20);--ax-t1: #121221;--ax-t2: #2E2E3D;--ax-t3: #3E3E4E;--ax-accent: #7A0047;--ax-accent-line: rgba(255, 98, 182, 0.55);--ax-accent-soft: #FFE9F4;--ax-on-accent: #121221;--ax-note: #E8F3EC;--ax-note-line: rgba(30, 70, 50, 0.24);--ax-note-t: #1B4230;--ax-warn: #FBEEE0;--ax-warn-line: rgba(90, 50, 0, 0.24);--ax-warn-t: #54300A;--ax-blue: #E7F3FD;--ax-blue-line: rgba(0, 82, 125, 0.24);--ax-blue-t: #00527D;--ax-danger: #FFEBE9;--ax-danger-line: rgba(207, 34, 46, 0.28);--ax-danger-t: #A40E26}html.dark{--ax-bg: #0A0A12;--ax-surface: #15151F;--ax-code-bg: #05050B;--ax-chip: #221B3A;--ax-line: rgba(247, 247, 252, 0.16);--ax-t1: #F5F5FA;--ax-t2: #DCDCE6;--ax-t3: #B3B3C4;--ax-accent: #FF8AC8;--ax-accent-line: rgba(255, 138, 200, 0.45);--ax-accent-soft: #2A1425;--ax-on-accent: #0A0A12;--ax-note: #10241A;--ax-note-line: rgba(159, 224, 188, 0.30);--ax-note-t: #9FE0BC;--ax-warn: #2A1B0A;--ax-warn-line: rgba(255, 201, 138, 0.30);--ax-warn-t: #FFC98A;--ax-blue: #0A1A24;--ax-blue-line: rgba(57, 195, 255, 0.30);--ax-blue-t: #97D8FF;--ax-danger: #2A0F12;--ax-danger-line: rgba(255, 138, 148, 0.30);--ax-danger-t: #FFB3B8}#content{line-height:1.75}#page-title,#content h1{font-size:clamp(2rem, 1.4rem + 2.1vw, 2.875rem);line-height:1.12;letter-spacing:-0.02em;font-weight:600}#content h2,#content h3,#content h4{letter-spacing:-0.01em;font-weight:600}#content code,#content kbd,#content samp{font-feature-settings:'tnum' 1}#content a:not(.card){color:var(--ax-accent);text-decoration-thickness:1px;text-underline-offset:3px}:focus-visible{outline:2px solid var(--ax-accent-line);outline-offset:2px}html.dark :focus-visible{outline-color:var(--ax-accent-line)}::selection{background:var(--ax-accent-soft)}#navbar{background:var(--ax-bg);border-bottom:1px solid var(--ax-line)}#navbar div:has(>.nav-tabs){position:relative}#navbar div:has(>.nav-tabs)::before{content:'';position:absolute;top:0;left:50%;width:100vw;margin-left:-50vw;border-top:1px solid var(--ax-line);pointer-events:none}.nav-tabs-item[data-active]{box-shadow:inset 0 -2px 0 var(--ax-accent)}.ax-product-selector{position:relative;display:inline-flex;align-items:stretch;flex:0 0 auto}.ax-product-selector--desktop{margin-left:0.75rem;align-self:center}.page-context-dropdown__label{font-family:inherit;font-weight:400}.page-context-dropdown__chevron>span{display:inline-block;transition:transform 150ms ease}.page-context-dropdown__chevron svg{display:block;width:1rem;height:1rem}.page-context-dropdown__chevron[aria-expanded=\"true\"]>span{transform:rotate(180deg)}.page-context-dropdown__menu{position:absolute;z-index:60;top:calc(100% + 0.55rem);right:0;min-width:12.5rem;padding:0.4rem;background:var(--ax-bg);border:1px solid var(--ax-line);border-radius:var(--ax-radius-md);box-shadow:0 0.75rem 1.5rem rgb(10 10 18 / 0.18)}.ax-product-selector--desktop .page-context-dropdown__menu{right:auto;left:0}.page-context-dropdown__menu[hidden]{display:none}.page-context-dropdown__item{display:flex;align-items:center;justify-content:space-between;min-height:2.5rem;padding:0.55rem 0.65rem;color:var(--ax-t1);border-radius:var(--ax-radius-sm);font-size:0.9375rem;font-weight:400;text-decoration:none;transition:background-color 150ms ease, color 150ms ease}.page-context-dropdown__item:hover,.page-context-dropdown__item:focus-visible{color:var(--ax-accent);background:var(--ax-accent-soft)}.page-context-dropdown__item[data-selected=\"true\"]{color:var(--ax-accent);font-weight:500}.page-context-dropdown__item[data-selected=\"true\"]::after{content:'ā';margin-left:1.5rem;color:var(--ax-accent);font-size:0.875rem}@media (prefers-reduced-motion: reduce){.page-context-dropdown__chevron>span,.page-context-dropdown__item{transition:none}}@media (max-width: 767px){#navbar .ax-product-selector--desktop{display:none}#mobile-nav-content .ax-product-selector--mobile{margin:0.5rem 0 1rem}#mobile-nav-content .page-context-dropdown__label{flex:1 1 auto}#mobile-nav-content .page-context-dropdown__chevron{flex:0 0 auto}#mobile-nav-content .page-context-dropdown__menu{position:static;margin-top:0.4rem}}#topbar-cta-button{background:var(--ax-accent-bg);color:var(--ax-on-accent);border-radius:var(--ax-radius-md);border:none}#topbar-cta-button span,#topbar-cta-button svg{color:var(--ax-on-accent)!important}#search-bar-entry{background:var(--ax-surface);border:1px solid var(--ax-line);border-radius:var(--ax-radius-md)}#assistant-entry{background:var(--ax-surface);border:1px solid var(--ax-accent-line);border-radius:var(--ax-radius-md)}#assistant-entry svg{color:var(--ax-accent)}#page-context-menu,.page-context-dropdown{font-size:0.9375rem;align-items:stretch}#page-context-menu-button,.page-context-dropdown__label{display:inline-flex;align-items:center;padding:10px 14px;border-radius:var(--ax-radius-md) 0 0 var(--ax-radius-md);background:var(--ax-surface);border-color:var(--ax-line);color:var(--ax-t1);border:1px solid var(--ax-line);text-decoration:none}#page-context-menu-button>div{font-size:0.9375rem;gap:9px}#page-context-menu>button[aria-haspopup],.page-context-dropdown__chevron{height:auto;align-self:stretch;aspect-ratio:auto;padding:10px 11px;border-radius:0 var(--ax-radius-md) var(--ax-radius-md) 0;background:var(--ax-surface);border-color:var(--ax-line);color:var(--ax-t3);border:1px solid var(--ax-line);border-left:0;cursor:pointer}#sidebar-content li[data-active]>a{background:var(--ax-accent-soft);color:var(--ax-accent);border-radius:var(--ax-radius-md);font-weight:500}.sidebar-group-header{font-weight:600;color:var(--ax-t1)}.toc-item[data-active],.toc-item[data-active] a{color:var(--ax-accent);font-weight:400}.card.card{background:var(--ax-surface);border-color:var(--ax-line);border-radius:var(--ax-radius-lg);box-shadow:none}.frame.frame{background:var(--ax-surface);border:1px solid var(--ax-line);border-radius:var(--ax-radius-lg)}.accordion.accordion,.accordion-group.accordion-group{border-radius:var(--ax-radius-md);border-color:var(--ax-line)}.accordion.accordion{background:var(--ax-surface)}.code-block.code-block,.code-group.code-group{background:var(--ax-code-bg);border-color:var(--ax-line);border-radius:var(--ax-radius-md)}.code-block-background{background:var(--ax-code-bg)!important}html.dark .code-block-background{background:var(--ax-code-bg)!important}#content :not(pre)>code{background:var(--ax-chip);border-radius:var(--ax-radius-sm)}.code-block:has([data-floating-buttons]) [data-fade-overlay]{background-image:none}[data-floating-buttons] button{background:var(--ax-chip)}.callout .code-block.code-block,.callout .code-group.code-group,.callout .code-block-background,html.dark .callout .code-block-background{background:var(--ax-bg)!important}.callout{border-radius:var(--ax-radius-lg)}.callout[data-callout-type=\"callout\"],.callout[data-callout-type=\"info\"]{background:var(--ax-surface);border-color:var(--ax-line)}.callout[data-callout-type=\"callout\"] [data-component-part=\"callout-content\"],.callout[data-callout-type=\"info\"] [data-component-part=\"callout-content\"]{color:var(--ax-t2)!important}.callout[data-callout-type=\"tip\"],.callout[data-callout-type=\"check\"]{background:var(--ax-note);border-color:var(--ax-note-line)}.callout[data-callout-type=\"tip\"] [data-component-part=\"callout-content\"],.callout[data-callout-type=\"check\"] [data-component-part=\"callout-content\"]{color:var(--ax-note-t)!important}.callout[data-callout-type=\"warning\"]{background:var(--ax-warn);border-color:var(--ax-warn-line)}.callout[data-callout-type=\"warning\"] [data-component-part=\"callout-content\"]{color:var(--ax-warn-t)!important}.callout[data-callout-type=\"note\"]{background:var(--ax-blue);border-color:var(--ax-blue-line)}.callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"]{color:var(--ax-blue-t)!important}.callout[data-callout-type=\"danger\"]{background:var(--ax-danger);border-color:var(--ax-danger-line)}.callout[data-callout-type=\"danger\"] [data-component-part=\"callout-content\"]{color:var(--ax-danger-t)!important}[data-component-part=\"step-number\"]>div{background:var(--ax-accent-soft);border:1px solid var(--ax-accent-line);color:var(--ax-accent);font-weight:500}.update.update-container{flex-direction:column;gap:0.5rem;border-top:1px solid var(--ax-line)}.update.update-container:first-of-type{border-top:none}.update.update-container>div:first-child{width:100%;position:static}.update.update-container>div:last-child{width:100%;max-width:none}#content th{color:var(--ax-t1);font-weight:600;border-bottom:1px solid var(--ax-line)}#content td{border-bottom:1px solid var(--ax-line)}footer{border-top:1px solid var(--ax-line)}.ax-hero .callout{background:var(--ax-panel);border-color:var(--ax-panel-border);border-radius:var(--ax-radius-lg)}.ax-hero .callout [data-component-part=\"callout-content\"],.ax-hero .callout p,.ax-hero .callout li{color:var(--ax-panel-t2)!important}.ax-hero .callout h2,.ax-hero .callout h3,.ax-hero .callout strong{color:var(--ax-panel-t1)!important}.ax-hero .callout [data-component-part=\"callout-icon\"] svg{background:var(--ax-panel-icon)!important}.ax-hero .code-block,.ax-hero .code-group,.ax-hero .code-block-background{background:var(--ax-panel-code)!important;border-color:var(--ax-panel-border)}.ax-hero .code-block,.ax-hero .code-group{padding:0;overflow:hidden}html.dark .ax-hero .code-block,html.dark .ax-hero .code-group,html.dark .ax-hero .code-block-background,html.dark .ax-hero .shiki,html:not(.dark) .ax-hero .code-block,html:not(.dark) .ax-hero .code-group,html:not(.dark) .ax-hero .code-block-background{background:var(--ax-panel-code)!important}html.dark .ax-hero .shiki,html.dark .ax-hero .shiki span{color:var(--ax-panel-t1)!important}html.dark .ax-hero .shiki span[style*=\"#FFA657\"]{color:var(--ax-panel-code-kw)!important}html.dark .ax-hero .shiki span[style*=\"#79C0FF\"]{color:var(--ax-panel-code-flag)!important}html.dark .ax-hero .shiki span[style*=\"#A5D6FF\"]{color:var(--ax-panel-code-url)!important}.ax-hero .code-group>div:first-child,html.dark .ax-hero .code-group>div:first-child{background:var(--ax-panel-2)!important;border-bottom:1px solid var(--ax-panel-border)}.ax-hero .code-group [role=\"tab\"]{color:var(--ax-panel-t2)!important}.ax-hero .code-group [role=\"tab\"][aria-selected=\"true\"]{color:var(--ax-panel-accent)!important}.ax-hero .code-group [role=\"tab\"][aria-selected=\"true\"]>div:last-child{background:var(--ax-panel-accent)!important}.ax-hero .code-block svg,.ax-hero .code-group svg{color:var(--ax-panel-t2)}html.dark .ax-hero [data-fade-overlay]{background-image:linear-gradient(\n to right,\n rgb(255 255 255 / 0) 0,\n rgb(255 255 255 / 0.2) 10px,\n rgb(255 255 255 / 0.5) 25px,\n rgb(255 255 255 / 0.8) 35px,\n rgb(255 255 255) 45px\n )}.ax-hero .callout a{color:var(--ax-panel-accent)!important}.ax-hero::selection,.ax-hero ::selection{background:var(--ax-panel-selection)}.card-group .card img{max-height:197px!important}.card-group[class$=\"-2\"] .card img{height:160px!important}.card-group[class$=\"-3\"] .card img{height:150px!important}table{display:table!important}.step-title{font-size:1.5rem!important}"}],"page":{"pagePath":"api-reference/annotation-queues/annotate-a-record","slug":"/api-reference/annotation-queues/annotate-a-record","pageMetadata":{"title":"Annotate a record","description":"Submit annotations for an annotation queue record.\n\nAnnotations are upserted into the underlying data source by annotation config name.\nOmitted annotation configs are left unchanged.\n\n**Payload Requirements**\n- `annotations` must contain at least one entry and at most 500.\n- Each annotation `name` must match an annotation config associated with the queue.\n- Omit `label`, `score`, or `text` to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written.\n\n**Response**\nReturns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only.\nEvaluations and user assignments are not included for performance reasons.\nUse the list records endpoint to retrieve the full record state.\n\n**Valid example**\n```json\n{\n \"annotations\": [\n {\"name\": \"accuracy\", \"label\": \"correct\", \"score\": 1.0},\n {\"name\": \"quality\", \"text\": \"Well-structured response\"}\n ]\n}\n```\n\n**Invalid example** (annotation name not in queue)\n```json\n{\n \"annotations\": [\n {\"name\": \"unknown_config\", \"label\": \"good\"}\n ]\n}\n```\n\n\u003cNote>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).\u003c/Note>\n","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/annotate","href":"/api-reference/annotation-queues/annotate-a-record","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock, Note} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n if (!Note) _missingMdxReference(\"Note\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Submit annotations for an annotation queue record.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Annotations are upserted into the underlying data source by annotation config name.\\nOmitted annotation configs are left unchanged.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Payload Requirements\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"annotations\"\n }), \" must contain at least one entry and at most 500.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Each annotation \", _jsx(_components.code, {\n children: \"name\"\n }), \" must match an annotation config associated with the queue.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Omit \", _jsx(_components.code, {\n children: \"label\"\n }), \", \", _jsx(_components.code, {\n children: \"score\"\n }), \", or \", _jsx(_components.code, {\n children: \"text\"\n }), \" to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Response\"\n }), \"\\nReturns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only.\\nEvaluations and user assignments are not included for performance reasons.\\nUse the list records endpoint to retrieve the full record state.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Valid example\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"6\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"6\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"annotations\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"accuracy\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"label\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"correct\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"score\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0550AE\",\n \"--shiki-dark\": \"#B5CEA8\"\n },\n children: \"1.0\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"},\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"quality\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"text\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Well-structured response\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ]\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Invalid example\"\n }), \" (annotation name not in queue)\"]\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"5\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"5\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"annotations\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": [\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" {\"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"unknown_config\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \", \"\n }), _jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \"\\\"label\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"good\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \" ]\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(Note, {\n children: [\"This endpoint is in beta, read more \", _jsx(_components.a, {\n href: \"https://arize.com/docs/ax/rest-reference#api-version-stages\",\n children: \"here\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light-default","dark":"github-dark-default"}},"config":{},"pageMetadata":{"title":"Annotate a record","description":"Submit annotations for an annotation queue record.\n\nAnnotations are upserted into the underlying data source by annotation config name.\nOmitted annotation configs are left unchanged.\n\n**Payload Requirements**\n- `annotations` must contain at least one entry and at most 500.\n- Each annotation `name` must match an annotation config associated with the queue.\n- Omit `label`, `score`, or `text` to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written.\n\n**Response**\nReturns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only.\nEvaluations and user assignments are not included for performance reasons.\nUse the list records endpoint to retrieve the full record state.\n\n**Valid example**\n```json\n{\n \"annotations\": [\n {\"name\": \"accuracy\", \"label\": \"correct\", \"score\": 1.0},\n {\"name\": \"quality\", \"text\": \"Well-structured response\"}\n ]\n}\n```\n\n**Invalid example** (annotation name not in queue)\n```json\n{\n \"annotations\": [\n {\"name\": \"unknown_config\", \"label\": \"good\"}\n ]\n}\n```\n\n\u003cNote>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).\u003c/Note>\n","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/annotate","href":"/api-reference/annotation-queues/annotate-a-record","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/arize-ax/6a30b7a67da02161/analytics.js","/docs/_mintlify/custom/arize-ax/67a4d27b62fababa/product-selector.js"],"openApiReferenceData":{"operation":{"x-release-status":"beta","tags":["Annotation Queues"],"operationId":"annotate_annotation_queue_record","summary":"Annotate a record","description":"Submit annotations for an annotation queue record.\n\nAnnotations are upserted into the underlying data source by annotation config name.\nOmitted annotation configs are left unchanged.\n\n**Payload Requirements**\n- `annotations` must contain at least one entry and at most 500.\n- Each annotation `name` must match an annotation config associated with the queue.\n- Omit `label`, `score`, or `text` to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written.\n\n**Response**\nReturns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only.\nEvaluations and user assignments are not included for performance reasons.\nUse the list records endpoint to retrieve the full record state.\n\n**Valid example**\n```json\n{\n \"annotations\": [\n {\"name\": \"accuracy\", \"label\": \"correct\", \"score\": 1.0},\n {\"name\": \"quality\", \"text\": \"Well-structured response\"}\n ]\n}\n```\n\n**Invalid example** (annotation name not in queue)\n```json\n{\n \"annotations\": [\n {\"name\": \"unknown_config\", \"label\": \"good\"}\n ]\n}\n```\n\n\u003cNote>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).\u003c/Note>\n","parameters":["26fbe89c-b16b-4d01-b49b-7559a0776aa6","c8b27897-6512-45ab-9ca5-081aef259cbd"],"requestBody":"ac8ba9d8-7bb6-46ea-9520-a1c5bea36ba7","responses":{"200":"9c9b5dd0-20f1-4a5d-95b2-ba2d454bddf3","400":"e4dd76ac-0b07-4cef-9f8c-6617a6b83a9c","401":"139e8eaa-e955-4baa-afde-31532c73925f","403":"b57aea10-1113-4496-bc82-ee9405ab5146","404":"69788fa5-0b8c-4ae5-9e44-4c00dba2ffed","422":"2faf8726-915b-451c-9d41-906973954174","429":"3d4635e0-f138-4861-8c53-e52176bd16eb"},"method":"post","type":"path","servers":["41acad41-ab19-4b4c-b465-a4976eae4f32","fd90bffd-59f4-44b9-8f51-950eb953252d","7ddd13fd-8149-4110-a240-53637921fee4"],"security":["47dce434-0a51-44e3-9495-f9b2ef2d887b"],"path":"/v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/annotate","baseUrlOptions":["https://api.arize.com","https://api.{region}.arize.com","https://{host}"],"title":"Annotate a record","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"26fbe89c-b16b-4d01-b49b-7559a0776aa6":{"name":"annotation_queue_id","in":"path","description":"The unique annotation queue identifier (base64)","required":true,"schema":{"type":"string","description":"The unique annotation queue identifier (base64)\nA universally unique identifier (base64-encoded opaque string).","example":"RW50aXR5OjEyMzQ1","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"QW5ub3RhdGlvblF1ZXVlOjEyMzQ1"},"c8b27897-6512-45ab-9ca5-081aef259cbd":{"name":"annotation_queue_record_id","in":"path","description":"The unique annotation queue record identifier (base64)","required":true,"schema":{"type":"string","description":"The unique annotation queue record identifier (base64)\nA universally unique identifier (base64-encoded opaque string).","example":"RW50aXR5OjEyMzQ1","isRequired":true,"uniqueKey":"","typeLabel":"string"},"example":"QW5ub3RhdGlvblF1ZXVlOjEyMzQ1"}},"requestBody":{"description":"Body containing annotations to submit for an annotation queue record","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Annotations to submit for an annotation queue record. Annotations are upserted by annotation config name; omitted configs are left unchanged.","required":["annotations"],"properties":{"annotations":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","description":"An annotation value to set on a record, identified by its annotation config name. Omitting a field leaves the existing value unchanged.","required":["name"],"properties":{"name":{"type":"string","description":"The annotation config name","example":"accuracy","isRequired":true,"uniqueKey":"annotations.items.[INDEX].name","typeLabel":"string"},"score":{"type":"number","format":"double","description":"Numeric score for the annotation. Omit to leave unchanged.","uniqueKey":"annotations.items.[INDEX].score","typeLabel":"number\u003cdouble>"},"label":{"type":"string","description":"Categorical label for the annotation. Omit to leave unchanged.","uniqueKey":"annotations.items.[INDEX].label","typeLabel":"string"},"text":{"type":"string","description":"Free-form text note for the annotation. Omit to leave unchanged.","uniqueKey":"annotations.items.[INDEX].text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"annotations.items.[INDEX]","typeLabel":"object"},"description":"Annotations to upsert on this record, keyed by annotation config name. At most 500 annotations may be submitted per request ā one per annotation config associated with the queue.","isRequired":true,"uniqueKey":"annotations","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"annotations":[{"name":"accuracy","score":0.95}]},"examples":{"Example":{"title":"Example","value":{"annotations":[{"name":"accuracy","score":0.95}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9c9b5dd0-20f1-4a5d-95b2-ba2d454bddf3":{"description":"Returns a snapshot of the record fields updated by the annotate operation. Only the submitted annotations are included. Evaluations and user assignments are omitted; use the list records endpoint for the full record state.","content":{"application/json":{"schema":{"type":"object","description":"A snapshot of the annotation queue record fields that were modified by an annotate operation. Only the record identity fields and the submitted annotations are returned. Evaluations and user assignments are not fetched and are not included in this response for performance reasons; use the list records endpoint to retrieve the full record state.","required":["id","annotation_queue_id","source_type","annotations"],"properties":{"id":{"type":"string","description":"The unique identifier for the record","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"annotation_queue_id":{"type":"string","description":"The annotation queue this record belongs to","isRequired":true,"uniqueKey":"annotation_queue_id","typeLabel":"string"},"source_type":{"type":"string","enum":["SPANS","DATASET"],"description":"Source type of the annotation queue record.\n- SPANS - The record originates from span data.\n- DATASET - The record originates from a dataset example.\n","isRequired":true,"uniqueKey":"source_type","typeLabel":"enum\u003cstring>"},"annotations":{"type":"array","items":{"type":"object","description":"A human annotation on a record.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the annotation","isRequired":true,"uniqueKey":"annotations.items.[INDEX].name","typeLabel":"string"},"score":{"type":"number","format":"double","description":"Numeric score for the annotation","uniqueKey":"annotations.items.[INDEX].score","typeLabel":"number\u003cdouble>"},"label":{"type":"string","description":"Categorical label for the annotation","uniqueKey":"annotations.items.[INDEX].label","typeLabel":"string"},"text":{"type":"string","description":"Free-form text note for the annotation","uniqueKey":"annotations.items.[INDEX].text","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the annotation was last updated","uniqueKey":"annotations.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"annotator":{"type":"object","description":"The user who made this annotation","required":["id","email"],"x-forward-compatible":true,"properties":{"id":{"type":"string","description":"The unique identifier for the user","isRequired":true,"uniqueKey":"annotations.items.[INDEX].annotator.id","typeLabel":"string"},"email":{"type":"string","format":"email","description":"An email address","example":"user@example.com","isRequired":true,"uniqueKey":"annotations.items.[INDEX].annotator.email","typeLabel":"string\u003cemail>"}},"additionalProperties":false,"uniqueKey":"annotations.items.[INDEX].annotator","typeLabel":"object"}},"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"annotations.items.[INDEX]","typeLabel":"object"},"description":"The annotations that were submitted in this request","isRequired":true,"uniqueKey":"annotations","typeLabel":"object[]"},"granularity":{"oneOf":[{"type":"string","description":"The granularity of the record, if applicable.","enum":["SPAN","TRACE","SESSION"],"uniqueKey":"granularity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"granularity.oneOf.1","typeLabel":"null"}],"uniqueKey":"granularity","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"id":"aqr_001","annotation_queue_id":"aq_abc123","source_type":"SPANS","annotations":[{"name":"accuracy","label":"correct","score":1,"annotator":{"id":"usr_123","email":"reviewer@example.com"}}]},"examples":{"Example":{"title":"Example","value":{"id":"aqr_001","annotation_queue_id":"aq_abc123","source_type":"SPANS","annotations":[{"name":"accuracy","label":"correct","score":1,"annotator":{"id":"usr_123","email":"reviewer@example.com"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"e4dd76ac-0b07-4cef-9f8c-6617a6b83a9c":{"description":"Invalid request","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":400,"title":"Invalid request parameters","detail":"The 'name' field is required and must be a non-empty string.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#invalid-request"},"examples":{"Example":{"title":"Example","value":{"status":400,"title":"Invalid request parameters","detail":"The 'name' field is required and must be a non-empty string.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#invalid-request"}}},"exampleType":"examples"}},"exampleType":"examples"},"139e8eaa-e955-4baa-afde-31532c73925f":{"description":"Authentication is required","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":401,"title":"Authentication required","detail":"You must be authenticated to access this resource.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#authentication-required"},"examples":{"Example":{"title":"Example","value":{"status":401,"title":"Authentication required","detail":"You must be authenticated to access this resource.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#authentication-required"}}},"exampleType":"examples"}},"exampleType":"examples"},"b57aea10-1113-4496-bc82-ee9405ab5146":{"description":"Insufficient permissions to access this resource","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":403,"title":"Access forbidden","detail":"You do not have permission to access this resource.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#access-forbidden"},"examples":{"Example":{"title":"Example","value":{"status":403,"title":"Access forbidden","detail":"You do not have permission to access this resource.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#access-forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"69788fa5-0b8c-4ae5-9e44-4c00dba2ffed":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":404,"title":"Resource not found","detail":"The requested resource with ID '12345' was not found.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#resource-not-found"},"examples":{"Example":{"title":"Example","value":{"status":404,"title":"Resource not found","detail":"The requested resource with ID '12345' was not found.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#resource-not-found"}}},"exampleType":"examples"}},"exampleType":"examples"},"2faf8726-915b-451c-9d41-906973954174":{"description":"Unprocessable entity","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":422,"title":"Unprocessable Entity","detail":"One or more fields failed validation.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"},"examples":{"Example":{"title":"Example","value":{"status":422,"title":"Unprocessable Entity","detail":"One or more fields failed validation.","instance":"/resource/12345","type":"https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"}}},"exampleType":"examples"}},"exampleType":"examples"},"3d4635e0-f138-4861-8c53-e52176bd16eb":{"description":"Rate limit exceeded","headers":{"Retry-After":{"description":"When throttled (429), how long to wait before retrying. Value is\neither a delta-seconds integer.\n","schema":{"type":"integer","minimum":0},"example":42}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 Problem Details","properties":{"title":{"type":"string","description":"A short, human-readable summary of the problem type","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type","uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"}},"required":["title","status"],"additionalProperties":false,"x-forward-compatible":true,"uniqueKey":"","typeLabel":"object"},"example":{"status":429,"title":"Rate limit exceeded","detail":"You have exceeded the allowed number of requests. Please try again later.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"},"examples":{"Example":{"title":"Example","value":{"status":429,"title":"Rate limit exceeded","detail":"You have exceeded the allowed number of requests. Please try again later.","instance":"/resource","type":"https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"47dce434-0a51-44e3-9495-f9b2ef2d887b":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"\u003capi-key>","description":"Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format\n``` Authorization: Bearer \u003capi-key>\n```\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"41acad41-ab19-4b4c-b465-a4976eae4f32":{"description":"Global","url":"https://api.arize.com"},"fd90bffd-59f4-44b9-8f51-950eb953252d":{"description":"Regional","url":"https://api.{region}.arize.com","variables":{"region":{"default":"eu-west-1a","enum":["eu-west-1a","ca-central-1a"]}}},"7ddd13fd-8149-4110-a240-53637921fee4":{"description":"Custom Host","url":"https://{host}","variables":{"host":{"default":"api.arize.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"\u003capi-key>","description":"Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format\n``` Authorization: Bearer \u003capi-key>\n```\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format\n``` Authorization: Bearer \u003capi-key>\n```\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://api.arize.com/v2/spec.yaml"},"subdomain":"arize-ax","siteName":"Arize AX Docs","title":"Annotate a record - Arize AX Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T20:06:26.977Z","originalFileLocation":"api-reference/annotation-queues/annotate-a-record.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Submit annotations for an annotation queue record. Annotations are upserted into the underlying data source by annotation config name. Omitted annotation configs are left unchanged. Payload Requirements - annotations must contain at least one entry and at most 500. - Each annotation name must match an annotation config associated with the queue. - Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written. Response Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only. Evaluations and user assignments are not included for performance reasons. Use the list records endpoint to retrieve the full record state. Valid example json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;accuracy\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;correct\u0026quot;, \u0026quot;score\u0026quot;: 1.0}, {\u0026quot;name\u0026quot;: \u0026quot;quality\u0026quot;, \u0026quot;text\u0026quot;: \u0026quot;Well-structured response\u0026quot;} ] } Invalid example (annotation name not in queue) json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;unknown_config\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;good\u0026quot;} ] } This endpoint is in beta, read more here.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Arize AX Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Annotate a record - Arize AX Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit annotations for an annotation queue record. Annotations are upserted into the underlying data source by annotation config name. Omitted annotation configs are left unchanged. Payload Requirements - annotations must contain at least one entry and at most 500. - Each annotation name must match an annotation config associated with the queue. - Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written. Response Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only. Evaluations and user assignments are not included for performance reasons. Use the list records endpoint to retrieve the full record state. Valid example json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;accuracy\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;correct\u0026quot;, \u0026quot;score\u0026quot;: 1.0}, {\u0026quot;name\u0026quot;: \u0026quot;quality\u0026quot;, \u0026quot;text\u0026quot;: \u0026quot;Well-structured response\u0026quot;} ] } Invalid example (annotation name not in queue) json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;unknown_config\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;good\u0026quot;} ] } This endpoint is in beta, read more here.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Arize AX Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://arize-ax.mintlify.site/docs/_mintlify/api/og/v2?division=Annotation+Queues\u0026amp;title=Annotate+a+record\u0026amp;description=Submit+annotations+for+an+annotation+queue+record.%0A%0AAnnotations+are+upserted+into+the+underlying+data+source+by+annotation+config+name.%0AOmitted+annotation+confi\u0026amp;theme=6b2e1c1a14346acb1262754f\u0026amp;signature=2c8ca484be9c38ec0c37e4a78e20206fc0dc9621ca5da307b8a57dc701818a63\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Annotate a record - Arize AX Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit annotations for an annotation queue record. Annotations are upserted into the underlying data source by annotation config name. Omitted annotation configs are left unchanged. Payload Requirements - annotations must contain at least one entry and at most 500. - Each annotation name must match an annotation config associated with the queue. - Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written. Response Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only. Evaluations and user assignments are not included for performance reasons. Use the list records endpoint to retrieve the full record state. Valid example json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;accuracy\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;correct\u0026quot;, \u0026quot;score\u0026quot;: 1.0}, {\u0026quot;name\u0026quot;: \u0026quot;quality\u0026quot;, \u0026quot;text\u0026quot;: \u0026quot;Well-structured response\u0026quot;} ] } Invalid example (annotation name not in queue) json { \u0026quot;annotations\u0026quot;: [ {\u0026quot;name\u0026quot;: \u0026quot;unknown_config\u0026quot;, \u0026quot;label\u0026quot;: \u0026quot;good\u0026quot;} ] } This endpoint is in beta, read more here.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://arize-ax.mintlify.site/docs/_mintlify/api/og/v2?division=Annotation+Queues\u0026amp;title=Annotate+a+record\u0026amp;description=Submit+annotations+for+an+annotation+queue+record.%0A%0AAnnotations+are+upserted+into+the+underlying+data+source+by+annotation+config+name.%0AOmitted+annotation+confi\u0026amp;theme=6b2e1c1a14346acb1262754f\u0026amp;signature=2c8ca484be9c38ec0c37e4a78e20206fc0dc9621ca5da307b8a57dc701818a63\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/arize-ax/vxzD83QsbAzzm43O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Arize AX Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7A0047\">\u003clink data-mint-head rel=\"canonical\" href=\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/annotation-queues/annotate-a-record.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://arize.com/#organization\",\"name\":\"Arize AX Docs\",\"url\":\"https://arize.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/arize-ax/V-uvingrGLOCK4VD/logo/light.svg?fit=max\u0026auto=format\u0026n=V-uvingrGLOCK4VD\u0026q=85\u0026s=cc58ee9388d5b5253d39b65cc662908f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://arize.com/docs#website\",\"name\":\"Arize AX Docs\",\"url\":\"https://arize.com/docs\",\"publisher\":{\"@id\":\"https://arize.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record#webpage\",\"url\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record\",\"name\":\"Annotate a record\",\"description\":\"Submit annotations for an annotation queue record. Annotations are upserted into the underlying data source by annotation config name. Omitted annotation configs are left unchanged. Payload Requirements - annotations must contain at least one entry and at most 500. - Each annotation name must match an annotation config associated with the queue. - Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written. Response Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only. Evaluations and user assignments are not included for performance reasons. Use the list records endpoint to retrieve the full record state. Valid example json { \\\"annotations\\\": [ {\\\"name\\\": \\\"accuracy\\\", \\\"label\\\": \\\"correct\\\", \\\"score\\\": 1.0}, {\\\"name\\\": \\\"quality\\\", \\\"text\\\": \\\"Well-structured response\\\"} ] } Invalid example (annotation name not in queue) json { \\\"annotations\\\": [ {\\\"name\\\": \\\"unknown_config\\\", \\\"label\\\": \\\"good\\\"} ] } This endpoint is in beta, read more here.\",\"dateModified\":\"2026-11-09T20:06:26.977Z\",\"isPartOf\":{\"@id\":\"https://arize.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://arize.com/docs/ax/rest-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST\",\"item\":\"https://arize.com/docs/ax/rest-reference/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Endpoints\",\"item\":\"https://arize.com/docs/api-reference/ai-integrations/list-ai-integrations\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Annotation Queues\",\"item\":\"https://arize.com/docs/api-reference/annotation-queues/list-annotation-queues\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Annotate a record\",\"item\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record#apireference\",\"headline\":\"Annotate a record\",\"name\":\"Annotate a record\",\"description\":\"Submit annotations for an annotation queue record. Annotations are upserted into the underlying data source by annotation config name. Omitted annotation configs are left unchanged. Payload Requirements - annotations must contain at least one entry and at most 500. - Each annotation name must match an annotation config associated with the queue. - Omit label, score, or text to leave the existing value unchanged. Individual fields cannot be set to null; annotations cannot be removed once written. Response Returns a snapshot of the fields updated by this operation: the record identity and the submitted annotations only. Evaluations and user assignments are not included for performance reasons. Use the list records endpoint to retrieve the full record state. Valid example json { \\\"annotations\\\": [ {\\\"name\\\": \\\"accuracy\\\", \\\"label\\\": \\\"correct\\\", \\\"score\\\": 1.0}, {\\\"name\\\": \\\"quality\\\", \\\"text\\\": \\\"Well-structured response\\\"} ] } Invalid example (annotation name not in queue) json { \\\"annotations\\\": [ {\\\"name\\\": \\\"unknown_config\\\", \\\"label\\\": \\\"good\\\"} ] } This endpoint is in beta, read more here.\",\"url\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record\",\"mainEntityOfPage\":{\"@id\":\"https://arize.com/docs/api-reference/annotation-queues/annotate-a-record#webpage\"},\"dateModified\":\"2026-11-09T20:06:26.977Z\",\"publisher\":{\"@id\":\"https://arize.com/#organization\"},\"isPartOf\":{\"@id\":\"https://arize.com/docs#website\"}}]}\u003c/script>","siteName":"Arize AX Docs","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/ax"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/ax/cookbooks"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/ax/integrations"}]},{"tab":"APIs, SDKs, Skills \u0026 MCP","pages":[{"title":"APIs, SDKs \u0026 Skills","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Choose the right interface for your workload","sidebarTitle":"Choosing an interface","href":"/api-reference/choosing-an-interface"},{"group":"Skills","pages":[{"title":"Skills","sidebarTitle":"Overview","href":"/ax/skills/overview"},{"title":"Install \u0026 authenticate","sidebarTitle":"Install \u0026 authenticate","href":"/ax/skills/install"},{"title":"Skill catalog","sidebarTitle":"Skill catalog","href":"/ax/skills/catalog"}]},{"group":"MCP server","pages":[{"title":"Arize AX MCP Server","sidebarTitle":"Overview","href":"/api-clients/mcp/overview"},{"title":"Connect to the AX MCP Server","sidebarTitle":"Connect your client","href":"/api-clients/mcp/connect"},{"group":"Reference","pages":[{"title":"AX MCP Authentication","sidebarTitle":"Authentication","href":"/api-clients/mcp/authentication"},{"title":"AX MCP Conventions","sidebarTitle":"Conventions","href":"/api-clients/mcp/conventions"},{"title":"AX MCP Endpoints","sidebarTitle":"Endpoints","href":"/api-clients/mcp/endpoints"},{"title":"Arize AX MCP Server FAQ","sidebarTitle":"FAQ","href":"/api-clients/mcp/faq"},{"title":"AX MCP Tool Catalog","sidebarTitle":"Tool catalog","href":"/api-clients/mcp/tool-catalog"}]}]},{"group":"API reference","pages":[{"group":"REST","pages":[{"title":"Arize REST API","sidebarTitle":"Overview","href":"/ax/rest-reference/overview"},{"title":"Error Reference","sidebarTitle":"Errors","href":"/ax/rest-reference/errors"},{"title":"Download OpenAPI Spec","href":"/ax/rest-reference/download-openapi-spec"},{"group":"Endpoints","pages":[{"group":"AI Integrations","pages":[{"title":"List AI integrations","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/ai-integrations","href":"/api-reference/ai-integrations/list-ai-integrations"},{"title":"Create an AI integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/ai-integrations","href":"/api-reference/ai-integrations/create-an-ai-integration"},{"title":"Get an AI integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/ai-integrations/{integration_id}","href":"/api-reference/ai-integrations/get-an-ai-integration"},{"title":"Delete an AI integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/ai-integrations/{integration_id}","href":"/api-reference/ai-integrations/delete-an-ai-integration"},{"title":"Update an AI integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/ai-integrations/{integration_id}","href":"/api-reference/ai-integrations/update-an-ai-integration"}]},{"group":"Alignment","pages":[{"title":"List alignment tasks","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/alignment-tasks","href":"/api-reference/alignment/list-alignment-tasks"},{"title":"Create alignment task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/alignment-tasks","href":"/api-reference/alignment/create-alignment-task"},{"title":"Get alignment task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/alignment-tasks/{alignment_task_id}","href":"/api-reference/alignment/get-alignment-task"},{"title":"List alignment runs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/alignment-tasks/{alignment_task_id}/runs","href":"/api-reference/alignment/list-alignment-runs"},{"title":"Create alignment run","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/alignment-tasks/{alignment_task_id}/runs","href":"/api-reference/alignment/create-alignment-run"}]},{"group":"Annotation Configs","pages":[{"title":"List annotation configs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-configs","href":"/api-reference/annotation-configs/list-annotation-configs"},{"title":"Create an annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-configs","href":"/api-reference/annotation-configs/create-an-annotation-config"},{"title":"Get an annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-configs/{annotation_config_id}","href":"/api-reference/annotation-configs/get-an-annotation-config"},{"title":"Delete an annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/annotation-configs/{annotation_config_id}","href":"/api-reference/annotation-configs/delete-an-annotation-config"},{"title":"Update an annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/annotation-configs/{annotation_config_id}","href":"/api-reference/annotation-configs/update-an-annotation-config"},{"title":"List tags on an annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-configs/{annotation_config_id}/tags","href":"/api-reference/annotation-configs/list-tags-on-an-annotation-config"},{"title":"Attach tags to a annotation config","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-configs/{annotation_config_id}/tags","href":"/api-reference/annotation-configs/attach-tags-to-a-annotation-config"}]},{"group":"Annotation Queues","pages":[{"title":"List annotation queues","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-queues","href":"/api-reference/annotation-queues/list-annotation-queues"},{"title":"Create an annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues","href":"/api-reference/annotation-queues/create-an-annotation-queue"},{"title":"Get an annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-queues/{annotation_queue_id}","href":"/api-reference/annotation-queues/get-an-annotation-queue"},{"title":"Delete an annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/annotation-queues/{annotation_queue_id}","href":"/api-reference/annotation-queues/delete-an-annotation-queue"},{"title":"Update an annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/annotation-queues/{annotation_queue_id}","href":"/api-reference/annotation-queues/update-an-annotation-queue"},{"title":"List annotation queue records","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-queues/{annotation_queue_id}/records","href":"/api-reference/annotation-queues/list-annotation-queue-records"},{"title":"Create annotation queue records","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/records","href":"/api-reference/annotation-queues/create-annotation-queue-records"},{"title":"Delete annotation queue records","description":"Delete one or more records from an annotation queue by their IDs.\n\nIf one or more record IDs are not found or do not belong to the specified\nqueue, they are silently ignored. A 204 response does not guarantee that\nall provided IDs were deleted.\n\nReturns 404 if the annotation queue specified by `annotation_queue_id` is not found.\nIndividual missing record IDs do not trigger a 404.\n","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/annotation-queues/{annotation_queue_id}/records","href":"/api-reference/annotation-queues/delete-annotation-queue-records"},{"title":"Annotate a record","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/annotate","href":"/api-reference/annotation-queues/annotate-a-record"},{"title":"Assign users to a record","description":"Assign users to an annotation queue record.\n\nFully replaces the current record-level user assignment. Re-assigning a user who has already\ncompleted their annotation resets their completion status to pending.\n\n**Payload Requirements**\n- `assigned_user_emails` fully replaces the existing record-level user assignment.\n- Pass an empty array to remove all record-level assignments.\n- At most 100 emails may be provided per request.\n- All emails must resolve to existing users with access to the queue's space.\n\n**Response**\nReturns a snapshot of the fields updated by this operation: the record identity and the resulting user assignments only.\nAnnotations and evaluations are not included for performance reasons.\nUse the list records endpoint to retrieve the full record state.\n\n**Valid example**\n```json\n{\n \"assigned_user_emails\": [\"reviewer@example.com\", \"annotator@example.com\"]\n}\n```\n\n**Invalid example** (email does not belong to the space)\n```json\n{\n \"assigned_user_emails\": [\"outsider@other.com\"]\n}\n```\n\n**Invalid example** (exceeds 100-email limit)\n```json\n{\n \"assigned_user_emails\": [\"user1@example.com\", \"user2@example.com\", \"...101 total emails\"]\n}\n```\n\n\u003cNote>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).\u003c/Note>\n","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/assign","href":"/api-reference/annotation-queues/assign-users-to-a-record"},{"title":"List tags on an annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/annotation-queues/{annotation_queue_id}/tags","href":"/api-reference/annotation-queues/list-tags-on-an-annotation-queue"},{"title":"Attach tags to a annotation queue","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/annotation-queues/{annotation_queue_id}/tags","href":"/api-reference/annotation-queues/attach-tags-to-a-annotation-queue"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Refresh an API key","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/api-keys/{api_key_id}/refresh","href":"/api-reference/api-keys/refresh-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml put /v2/api-keys/{api_key_id}/revoke","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Audit Logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/audit-logs","href":"/api-reference/audit-logs/list-audit-logs"}]},{"group":"Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/dashboards","href":"/api-reference/dashboards/list-dashboards"},{"title":"Create a dashboard","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/dashboards","href":"/api-reference/dashboards/create-a-dashboard"},{"title":"Get a dashboard","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/dashboards/{dashboard_id}","href":"/api-reference/dashboards/get-a-dashboard"},{"title":"List dashboard widgets","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/dashboards/{dashboard_id}/widgets","href":"/api-reference/dashboards/list-dashboard-widgets"},{"title":"Get a dashboard widget","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/dashboards/{dashboard_id}/widgets/{widget_id}","href":"/api-reference/dashboards/get-a-dashboard-widget"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/datasets","href":"/api-reference/datasets/list-datasets"},{"title":"Create a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/datasets","href":"/api-reference/datasets/create-a-dataset"},{"title":"Get a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/datasets/{dataset_id}","href":"/api-reference/datasets/get-a-dataset"},{"title":"Delete a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/datasets/{dataset_id}","href":"/api-reference/datasets/delete-a-dataset"},{"title":"Update a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/datasets/{dataset_id}","href":"/api-reference/datasets/update-a-dataset"},{"title":"List dataset examples","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/datasets/{dataset_id}/examples","href":"/api-reference/datasets/list-dataset-examples"},{"title":"Add new examples to a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/datasets/{dataset_id}/examples","href":"/api-reference/datasets/add-new-examples-to-a-dataset"},{"title":"Delete dataset examples","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/datasets/{dataset_id}/examples","href":"/api-reference/datasets/delete-dataset-examples"},{"title":"Update existing examples in a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/datasets/{dataset_id}/examples","href":"/api-reference/datasets/update-existing-examples-in-a-dataset"},{"title":"Annotate a batch of dataset examples","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/datasets/{dataset_id}/examples/annotate","href":"/api-reference/datasets/annotate-a-batch-of-dataset-examples"},{"title":"Search dataset examples","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/datasets/{dataset_id}/examples/search","href":"/api-reference/datasets/search-dataset-examples"},{"title":"List tags on a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/datasets/{dataset_id}/tags","href":"/api-reference/datasets/list-tags-on-a-dataset"},{"title":"Attach tags to a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/datasets/{dataset_id}/tags","href":"/api-reference/datasets/attach-tags-to-a-dataset"},{"title":"Detach tags from a dataset","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/datasets/{dataset_id}/tags","href":"/api-reference/datasets/detach-tags-from-a-dataset"}]},{"group":"Evaluators","pages":[{"title":"List evaluator templates","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluator-templates","href":"/api-reference/evaluators/list-evaluator-templates"},{"title":"Get evaluator version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluator-versions/{version_id}","href":"/api-reference/evaluators/get-evaluator-version"},{"title":"List evaluators","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluators","href":"/api-reference/evaluators/list-evaluators"},{"title":"Create evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/evaluators","href":"/api-reference/evaluators/create-evaluator"},{"title":"Get evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluators/{evaluator_id}","href":"/api-reference/evaluators/get-evaluator"},{"title":"Delete evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/evaluators/{evaluator_id}","href":"/api-reference/evaluators/delete-evaluator"},{"title":"Update evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/evaluators/{evaluator_id}","href":"/api-reference/evaluators/update-evaluator"},{"title":"List tags on an evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluators/{evaluator_id}/tags","href":"/api-reference/evaluators/list-tags-on-an-evaluator"},{"title":"Attach tags to a evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/evaluators/{evaluator_id}/tags","href":"/api-reference/evaluators/attach-tags-to-a-evaluator"},{"title":"Detach tags from a evaluator","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/evaluators/{evaluator_id}/tags","href":"/api-reference/evaluators/detach-tags-from-a-evaluator"},{"title":"List evaluator versions","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/evaluators/{evaluator_id}/versions","href":"/api-reference/evaluators/list-evaluator-versions"},{"title":"Create evaluator version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/evaluators/{evaluator_id}/versions","href":"/api-reference/evaluators/create-evaluator-version"},{"title":"Delete evaluator versions","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/evaluators/{evaluator_id}/versions","href":"/api-reference/evaluators/delete-evaluator-versions"}]},{"group":"Experiments","pages":[{"title":"List experiments","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/experiments","href":"/api-reference/experiments/list-experiments"},{"title":"Create an experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/experiments","href":"/api-reference/experiments/create-an-experiment"},{"title":"Get an experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/experiments/{experiment_id}","href":"/api-reference/experiments/get-an-experiment"},{"title":"Delete an experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/experiments/{experiment_id}","href":"/api-reference/experiments/delete-an-experiment"},{"title":"List experiment runs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/experiments/{experiment_id}/runs","href":"/api-reference/experiments/list-experiment-runs"},{"title":"Append runs to an experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/experiments/{experiment_id}/runs","href":"/api-reference/experiments/append-runs-to-an-experiment"},{"title":"Annotate a batch of experiment runs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/experiments/{experiment_id}/runs/annotate","href":"/api-reference/experiments/annotate-a-batch-of-experiment-runs"},{"title":"Search experiment runs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/experiments/{experiment_id}/runs/search","href":"/api-reference/experiments/search-experiment-runs"},{"title":"List tags on an experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/experiments/{experiment_id}/tags","href":"/api-reference/experiments/list-tags-on-an-experiment"},{"title":"Attach tags to a experiment","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/experiments/{experiment_id}/tags","href":"/api-reference/experiments/attach-tags-to-a-experiment"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Create an integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Get an integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/integrations/{integration_id}","href":"/api-reference/integrations/get-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/integrations/{integration_id}","href":"/api-reference/integrations/delete-an-integration"},{"title":"Update an integration","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/integrations/{integration_id}","href":"/api-reference/integrations/update-an-integration"}]},{"group":"Monitors","pages":[{"title":"List monitors","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/monitors","href":"/api-reference/monitors/list-monitors"},{"title":"Get a monitor","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/monitors/{monitor_id}","href":"/api-reference/monitors/get-a-monitor"},{"title":"List tags on a monitor","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/monitors/{monitor_id}/tags","href":"/api-reference/monitors/list-tags-on-a-monitor"},{"title":"Attach tags to a monitor","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/monitors/{monitor_id}/tags","href":"/api-reference/monitors/attach-tags-to-a-monitor"},{"title":"Detach tags from a monitor","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/monitors/{monitor_id}/tags","href":"/api-reference/monitors/detach-tags-from-a-monitor"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/organizations","href":"/api-reference/organizations/create-an-organization"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/organizations/{org_id}","href":"/api-reference/organizations/get-an-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/organizations/{org_id}","href":"/api-reference/organizations/delete-an-organization"},{"title":"Update an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/organizations/{org_id}","href":"/api-reference/organizations/update-an-organization"},{"title":"Add a user to an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/organizations/{org_id}/users","href":"/api-reference/organizations/add-a-user-to-an-organization"},{"title":"Remove a user from an organization","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/organizations/{org_id}/users/{user_id}","href":"/api-reference/organizations/remove-a-user-from-an-organization"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/projects","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/projects/{project_id}","href":"/api-reference/projects/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/projects/{project_id}","href":"/api-reference/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/projects/{project_id}","href":"/api-reference/projects/update-a-project"},{"title":"List tags on a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/projects/{project_id}/tags","href":"/api-reference/projects/list-tags-on-a-project"},{"title":"Attach tags to a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/projects/{project_id}/tags","href":"/api-reference/projects/attach-tags-to-a-project"},{"title":"Detach tags from a project","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/projects/{project_id}/tags","href":"/api-reference/projects/detach-tags-from-a-project"}]},{"group":"Prompts","pages":[{"title":"List prompts","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompts","href":"/api-reference/prompts/list-prompts"},{"title":"Create a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/prompts","href":"/api-reference/prompts/create-a-prompt"},{"title":"Get a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompts/{prompt_id}","href":"/api-reference/prompts/get-a-prompt"},{"title":"Delete a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/prompts/{prompt_id}","href":"/api-reference/prompts/delete-a-prompt"},{"title":"Update a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/prompts/{prompt_id}","href":"/api-reference/prompts/update-a-prompt"},{"title":"Resolve a label to a prompt version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompts/{prompt_id}/labels/{label_name}","href":"/api-reference/prompts/resolve-a-label-to-a-prompt-version"},{"title":"List tags on a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompts/{prompt_id}/tags","href":"/api-reference/prompts/list-tags-on-a-prompt"},{"title":"Attach tags to a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/prompts/{prompt_id}/tags","href":"/api-reference/prompts/attach-tags-to-a-prompt"},{"title":"Detach tags from a prompt","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/prompts/{prompt_id}/tags","href":"/api-reference/prompts/detach-tags-from-a-prompt"},{"title":"List prompt versions","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompts/{prompt_id}/versions","href":"/api-reference/prompts/list-prompt-versions"},{"title":"Create a prompt version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/prompts/{prompt_id}/versions","href":"/api-reference/prompts/create-a-prompt-version"},{"title":"Get a prompt version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/prompt-versions/{version_id}","href":"/api-reference/prompts/get-a-prompt-version"},{"title":"Set labels on a prompt version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml put /v2/prompt-versions/{version_id}/labels","href":"/api-reference/prompts/set-labels-on-a-prompt-version"},{"title":"Remove a label from a prompt version","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/prompt-versions/{version_id}/labels/{label_name}","href":"/api-reference/prompts/remove-a-label-from-a-prompt-version"}]},{"group":"Resource Restrictions","pages":[{"title":"List resource restrictions the caller is permitted to manage.","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/resource-restrictions","href":"/api-reference/resource-restrictions/list-resource-restrictions-the-caller-is-permitted-to-manage"},{"title":"Restrict a resource","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/resource-restrictions","href":"/api-reference/resource-restrictions/restrict-a-resource"},{"title":"Unrestrict a resource","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/resource-restrictions/{resource_id}","href":"/api-reference/resource-restrictions/unrestrict-a-resource"}]},{"group":"Role Bindings","pages":[{"title":"List role bindings","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/role-bindings","href":"/api-reference/role-bindings/list-role-bindings"},{"title":"Create a role binding","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/role-bindings","href":"/api-reference/role-bindings/create-a-role-binding"},{"title":"Get a role binding","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/role-bindings/{binding_id}","href":"/api-reference/role-bindings/get-a-role-binding"},{"title":"Delete a role binding","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/role-bindings/{binding_id}","href":"/api-reference/role-bindings/delete-a-role-binding"},{"title":"Update a role binding","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/role-bindings/{binding_id}","href":"/api-reference/role-bindings/update-a-role-binding"}]},{"group":"Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/roles","href":"/api-reference/roles/list-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/roles","href":"/api-reference/roles/create-a-role"},{"title":"Get a role","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/roles/{role_id}","href":"/api-reference/roles/get-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/roles/{role_id}","href":"/api-reference/roles/delete-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/roles/{role_id}","href":"/api-reference/roles/update-a-role"}]},{"group":"SAML","pages":[{"title":"List SAML identity providers","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/saml-identity-providers","href":"/api-reference/saml/list-saml-identity-providers"},{"title":"Create a SAML identity provider","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/saml-identity-providers","href":"/api-reference/saml/create-a-saml-identity-provider"},{"title":"Get a SAML identity provider","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/saml-identity-providers/{idp_id}","href":"/api-reference/saml/get-a-saml-identity-provider"},{"title":"Remove a SAML identity provider","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/saml-identity-providers/{idp_id}","href":"/api-reference/saml/remove-a-saml-identity-provider"},{"title":"Update supplied SAML configuration fields","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/saml-identity-providers/{idp_id}","href":"/api-reference/saml/update-supplied-saml-configuration-fields"},{"title":"List SAML role mappings","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/saml-identity-providers/{idp_id}/role-mappings","href":"/api-reference/saml/list-saml-role-mappings"},{"title":"Add a SAML role mapping","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/saml-identity-providers/{idp_id}/role-mappings","href":"/api-reference/saml/add-a-saml-role-mapping"},{"title":"Remove a SAML role mapping","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/saml-identity-providers/{idp_id}/role-mappings/{mapping_id}","href":"/api-reference/saml/remove-a-saml-role-mapping"},{"title":"Update supplied mapping fields","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/saml-identity-providers/{idp_id}/role-mappings/{mapping_id}","href":"/api-reference/saml/update-supplied-mapping-fields"}]},{"group":"Spaces","pages":[{"title":"List spaces","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/spaces","href":"/api-reference/spaces/list-spaces"},{"title":"Create a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/spaces","href":"/api-reference/spaces/create-a-space"},{"title":"Get a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/spaces/{space_id}","href":"/api-reference/spaces/get-a-space"},{"title":"Delete a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/spaces/{space_id}","href":"/api-reference/spaces/delete-a-space"},{"title":"Update a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/spaces/{space_id}","href":"/api-reference/spaces/update-a-space"},{"title":"Add a user to a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/spaces/{space_id}/users","href":"/api-reference/spaces/add-a-user-to-a-space"},{"title":"Remove a user from a space","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/spaces/{space_id}/users/{user_id}","href":"/api-reference/spaces/remove-a-user-from-a-space"}]},{"group":"Spans","pages":[{"title":"List spans","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/spans","href":"/api-reference/spans/list-spans"},{"title":"Delete spans","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/spans","href":"/api-reference/spans/delete-spans"},{"title":"Annotate a batch of project spans","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/spans/annotate","href":"/api-reference/spans/annotate-a-batch-of-project-spans"}]},{"group":"Tags","pages":[{"title":"Create a tag","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/tags/{tag_id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/tags/{tag_id}","href":"/api-reference/tags/update-a-tag"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/tasks","href":"/api-reference/tasks/create-task"},{"title":"Get task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/tasks/{task_id}","href":"/api-reference/tasks/get-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/tasks/{task_id}","href":"/api-reference/tasks/delete-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/tasks/{task_id}","href":"/api-reference/tasks/update-task"},{"title":"List task runs","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/tasks/{task_id}/runs","href":"/api-reference/tasks/list-task-runs"},{"title":"Trigger a task run","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/tasks/{task_id}/trigger","href":"/api-reference/tasks/trigger-a-task-run"},{"title":"Get task run","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/task-runs/{run_id}","href":"/api-reference/tasks/get-task-run"},{"title":"Cancel task run","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/task-runs/{run_id}/cancel","href":"/api-reference/tasks/cancel-task-run"}]},{"group":"Traces","pages":[{"title":"List traces","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/traces","href":"/api-reference/traces/list-traces"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/users","href":"/api-reference/users/list-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/users","href":"/api-reference/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/users/{user_id}","href":"/api-reference/users/get-a-user"},{"title":"Delete a user","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/users/{user_id}","href":"/api-reference/users/delete-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/users/{user_id}","href":"/api-reference/users/update-a-user"},{"title":"Resend a user invitation","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/users/{user_id}/resend-invitation","href":"/api-reference/users/resend-a-user-invitation"},{"title":"Trigger a password-reset email for a user","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/users/{user_id}/reset-password","href":"/api-reference/users/trigger-a-password-reset-email-for-a-user"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/webhook-subscriptions","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/webhook-subscriptions","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/webhook-subscriptions/{subscription_id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/webhook-subscriptions/{subscription_id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml delete /v2/webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml patch /v2/webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"List a webhook's delivery attempts","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml get /v2/webhooks/{webhook_id}/delivery-attempts","href":"/api-reference/webhooks/list-a-webhooks-delivery-attempts"},{"title":"Send a test event to a webhook","deprecated":null,"version":null,"openapi":"https://api.arize.com/v2/spec.yaml post /v2/webhooks/{webhook_id}/test","href":"/api-reference/webhooks/send-a-test-event-to-a-webhook"}]}]}]},{"group":"GraphQL","pages":[{"title":"GraphQL API","sidebarTitle":"GraphQL API Overview","href":"/ax/graphql-reference"},{"title":"Getting Started with GraphQL","href":"/ax/graphql-reference/overview/getting-started-with-graphql"},{"title":"API Explorer","href":"/ax/graphql-reference/overview/api-explorer"},{"group":"How to use GraphQL","pages":[{"title":"How to Use GraphQL","sidebarTitle":"Overview","href":"/ax/graphql-reference/overview/how-to-use-graphql"},{"title":"Forming Calls","href":"/ax/graphql-reference/overview/how-to-use-graphql/forming-calls"},{"title":"Using global node IDs","href":"/ax/graphql-reference/overview/how-to-use-graphql/using-global-node-ids"},{"title":"Querying Nested Data","href":"/ax/graphql-reference/overview/how-to-use-graphql/querying-nested-data"},{"title":"Notebook Examples","href":"/ax/graphql-reference/overview/how-to-use-graphql/notebook-examples"},{"title":"Mutations","href":"/ax/graphql-reference/overview/how-to-use-graphql/mutations"}]},{"title":"Resource Limitations","href":"/ax/graphql-reference/overview/resource-limitations"},{"group":"Guides","pages":[{"title":"Managing spaces, keys and SSO with GraphQL","href":"/ax/graphql-reference/guides/admin"},{"title":"Managing monitors with GraphQL","href":"/ax/graphql-reference/guides/monitors"},{"title":"Managing dashboards with GraphQL","href":"/ax/graphql-reference/guides/dashboards"},{"title":"Managing projects and models with GraphQL","href":"/ax/graphql-reference/guides/projects-and-models"},{"title":"Importing data with GraphQL","href":"/ax/graphql-reference/guides/data-import"},{"title":"Managing evaluators and tasks with GraphQL","href":"/ax/graphql-reference/guides/evaluators-and-tasks"},{"title":"Managing datasets and annotations with GraphQL","href":"/ax/graphql-reference/guides/datasets-and-annotations"},{"title":"Managing prompts with GraphQL","href":"/ax/graphql-reference/guides/prompts"},{"title":"Managing LLM integrations with GraphQL","href":"/ax/graphql-reference/guides/llm-integrations"},{"title":"Managed agents and Signal via GraphQL","href":"/ax/graphql-reference/guides/managed-agents-and-signal"}]},{"group":"Mutation reference","pages":[{"title":"All GraphQL mutations","href":"/ax/graphql-reference/mutations/index"},{"title":"Admin mutations","href":"/ax/graphql-reference/mutations/admin"},{"title":"Monitor mutations","href":"/ax/graphql-reference/mutations/monitors"},{"title":"Dashboard mutations","href":"/ax/graphql-reference/mutations/dashboards"},{"title":"Project and model mutations","href":"/ax/graphql-reference/mutations/projects-and-models"},{"title":"Data import mutations","href":"/ax/graphql-reference/mutations/data-import"},{"title":"Evaluator and task mutations","href":"/ax/graphql-reference/mutations/evaluators-and-tasks"},{"title":"Dataset and annotation mutations","href":"/ax/graphql-reference/mutations/datasets-and-annotations"},{"title":"Prompt mutations","href":"/ax/graphql-reference/mutations/prompts"},{"title":"LLM integration mutations","href":"/ax/graphql-reference/mutations/llm-integrations"},{"title":"Managed agent and Signal mutations","href":"/ax/graphql-reference/mutations/managed-agents-and-signal"}]},{"group":"Query reference","pages":[{"title":"Root queries","href":"/ax/graphql-reference/queries/root-queries"},{"title":"Object graph","href":"/ax/graphql-reference/queries/object-graph"}]}]}]},{"group":"API clients","pages":[{"group":"Python SDK","pages":[{"title":"Python SDK","sidebarTitle":"Overview","href":"/api-clients/python/overview"},{"group":"Version 8","pages":[{"title":"Python SDK v8","sidebarTitle":"Overview","href":"/api-clients/python/version-8/overview"},{"group":"Tutorial","pages":[{"title":"Send Traces to Arize AX","href":"/api-clients/python/version-8/tutorial/get-started-tracing-with-arize-sdk"},{"title":"Run and Log Evals to Measure Performance","href":"/api-clients/python/version-8/tutorial/get-started-evaluations-with-arize-sdk"},{"title":"Iterate with Experiments","href":"/api-clients/python/version-8/tutorial/get-started-datasets-experiments-with-arize-sdk"}]},{"title":"OpenTelemetry Tracing","href":"/api-clients/python/version-8/tracing"},{"title":"AI Integrations","href":"/api-clients/python/version-8/client-resources/ai-integrations"},{"title":"Annotation Configs","href":"/api-clients/python/version-8/client-resources/annotation-configs"},{"title":"Annotation Queues","href":"/api-clients/python/version-8/client-resources/annotation-queues"},{"title":"API Keys","href":"/api-clients/python/version-8/client-resources/api-keys"},{"title":"Audit Logs","href":"/api-clients/python/version-8/client-resources/audit-logs"},{"title":"Datasets","href":"/api-clients/python/version-8/client-resources/datasets"},{"title":"Evaluators","href":"/api-clients/python/version-8/client-resources/evaluators"},{"title":"Experiments","href":"/api-clients/python/version-8/client-resources/experiments"},{"title":"Integrations","href":"/api-clients/python/version-8/client-resources/integrations"},{"title":"ML Models","href":"/api-clients/python/version-8/client-resources/ml-models"},{"title":"Organizations","href":"/api-clients/python/version-8/client-resources/organizations"},{"title":"Projects","href":"/api-clients/python/version-8/client-resources/projects"},{"title":"Prompts","href":"/api-clients/python/version-8/client-resources/prompts"},{"title":"Resource Restrictions","href":"/api-clients/python/version-8/client-resources/resource-restrictions"},{"title":"Role Bindings","href":"/api-clients/python/version-8/client-resources/role-bindings"},{"title":"Roles","href":"/api-clients/python/version-8/client-resources/roles"},{"title":"SAML Identity Providers","href":"/api-clients/python/version-8/client-resources/saml-identity-providers"},{"title":"Spaces","href":"/api-clients/python/version-8/client-resources/spaces"},{"title":"Spans","href":"/api-clients/python/version-8/client-resources/spans"},{"title":"Tasks","href":"/api-clients/python/version-8/client-resources/tasks"},{"title":"Traces","href":"/api-clients/python/version-8/client-resources/traces"},{"title":"Users","href":"/api-clients/python/version-8/client-resources/users"},{"title":"Webhooks","href":"/api-clients/python/version-8/client-resources/webhooks"},{"title":"Embeddings","href":"/api-clients/python/version-8/embeddings"},{"title":"Utilities","href":"/api-clients/python/version-8/utils"},{"group":"Migration from v7","pages":[{"title":"Migration Overview","sidebarTitle":"Overview","href":"/api-clients/python/version-8/migration/index"},{"title":"Migrate Pandas Client","sidebarTitle":"Pandas Client","href":"/api-clients/python/version-8/migration/pandas-client"},{"title":"Migrate Stream Client","sidebarTitle":"Stream Client","href":"/api-clients/python/version-8/migration/stream-client"},{"group":"Datasets Client","pages":[{"title":"Migrate Datasets Client","sidebarTitle":"Datasets","href":"/api-clients/python/version-8/migration/datasets-client"},{"title":"Migrate Experiments Client","sidebarTitle":"Experiments","href":"/api-clients/python/version-8/migration/experiments-client"}]},{"title":"Migrate Exporter Client","sidebarTitle":"Exporter","href":"/api-clients/python/version-8/migration/exporter-client"}]}]},{"group":"Version 7","pages":[{"title":"Python SDK v7","sidebarTitle":"Overview","href":"/api-clients/python/version-7/overview"},{"title":"Export Data API","href":"/api-clients/python/version-7/export-data-api"},{"title":"Prompt Hub API","href":"/api-clients/python/version-7/prompt-hub-api"},{"group":"Pandas Batch Logging","pages":[{"title":"Pandas batch logging","sidebarTitle":"Overview","href":"/api-clients/python/version-7/ml-logging/arize-pandas"},{"title":"Client","href":"/api-clients/python/version-7/ml-logging/arize-pandas/client"},{"title":"Log","href":"/api-clients/python/version-7/ml-logging/arize-pandas/log"},{"title":"Schema","href":"/api-clients/python/version-7/ml-logging/arize-pandas/schema"},{"title":"TypedColumns","href":"/api-clients/python/version-7/ml-logging/arize-pandas/typedcolumns"},{"title":"EmbeddingColumnNames","href":"/api-clients/python/version-7/ml-logging/arize-pandas/embeddingcolumnnames"},{"title":"ObjectDetectionColumnNames","href":"/api-clients/python/version-7/ml-logging/arize-pandas/objectdetectioncolumnnames"},{"title":"PromptTemplateColumnNames","href":"/api-clients/python/version-7/ml-logging/arize-pandas/prompttemplatecolumnnames"},{"title":"LLMConfigColumnNames","href":"/api-clients/python/version-7/ml-logging/arize-pandas/llmconfigcolumnnames"},{"title":"LLMRunMetadataColumnNames","href":"/api-clients/python/version-7/ml-logging/arize-pandas/llmrunmetadatacolumnnames"},{"title":"NLP_Metrics","sidebarTitle":"NLPĀ Metrics","href":"/api-clients/python/version-7/ml-logging/arize-pandas/llm-evaluation"},{"title":"AutoEmbeddings","href":"/api-clients/python/version-7/ml-logging/arize-pandas/autoembeddings"},{"title":"Utils.Types.ModelTypes","href":"/api-clients/python/version-7/ml-logging/arize-pandas/utils.types.modeltypes"},{"title":"Utils.Types.Metrics","href":"/api-clients/python/version-7/ml-logging/arize-pandas/utils.types.metrics"},{"title":"Utils.Types.Environments","href":"/api-clients/python/version-7/ml-logging/arize-pandas/utils.types.environments"}]},{"group":"Single Record Logging","pages":[{"title":"Single Record Logging","sidebarTitle":"Overview","href":"/api-clients/python/version-7/ml-logging/arize-log"},{"title":"Client","href":"/api-clients/python/version-7/ml-logging/arize-log/client"},{"title":"Log","href":"/api-clients/python/version-7/ml-logging/arize-log/logpage"},{"title":"TypedValue","href":"/api-clients/python/version-7/ml-logging/arize-log/typedvalue"},{"title":"Ranking","href":"/api-clients/python/version-7/ml-logging/arize-log/ranking"},{"title":"Multi class","href":"/api-clients/python/version-7/ml-logging/arize-log/multi-class"},{"title":"Object detection","href":"/api-clients/python/version-7/ml-logging/arize-log/objectdetection"},{"title":"Embedding","href":"/api-clients/python/version-7/ml-logging/arize-log/embedding"},{"title":"LLMRunMetadata","href":"/api-clients/python/version-7/ml-logging/arize-log/llmrunmetadata"},{"title":"Utils.Types.ModelTypes","href":"/api-clients/python/version-7/ml-logging/arize-log/utils.types.modeltypes"},{"title":"Utils.Types.Metrics","href":"/api-clients/python/version-7/ml-logging/arize-log/utils.types.metrics"},{"title":"Utils.Types.Environments","href":"/api-clients/python/version-7/ml-logging/arize-log/utils.types.environments"}]}]}]},{"group":"TypeScript SDK","pages":[{"group":"Version 1","pages":[{"title":"TypeScript SDK v1","sidebarTitle":"Overview","href":"/api-clients/typescript/version-1/overview"},{"title":"AI Integrations","href":"/api-clients/typescript/version-1/client-resources/ai-integrations"},{"title":"Annotation Configs","href":"/api-clients/typescript/version-1/client-resources/annotation-configs"},{"title":"Annotation Queues","href":"/api-clients/typescript/version-1/client-resources/annotation-queues"},{"title":"API Keys","href":"/api-clients/typescript/version-1/client-resources/api-keys"},{"title":"Audit Logs","href":"/api-clients/typescript/version-1/client-resources/audit-logs"},{"title":"Datasets","href":"/api-clients/typescript/version-1/client-resources/datasets"},{"title":"Evaluators","href":"/api-clients/typescript/version-1/client-resources/evaluators"},{"title":"Experiments","href":"/api-clients/typescript/version-1/client-resources/experiments"},{"title":"Integrations","href":"/api-clients/typescript/version-1/client-resources/integrations"},{"title":"Organizations","href":"/api-clients/typescript/version-1/client-resources/organizations"},{"title":"Projects","href":"/api-clients/typescript/version-1/client-resources/projects"},{"title":"Prompts","href":"/api-clients/typescript/version-1/client-resources/prompts"},{"title":"Resource Restrictions","href":"/api-clients/typescript/version-1/client-resources/resource-restrictions"},{"title":"Role Bindings","href":"/api-clients/typescript/version-1/client-resources/role-bindings"},{"title":"Roles","href":"/api-clients/typescript/version-1/client-resources/roles"},{"title":"Spaces","href":"/api-clients/typescript/version-1/client-resources/spaces"},{"title":"Spans","href":"/api-clients/typescript/version-1/client-resources/spans"},{"title":"Tasks","href":"/api-clients/typescript/version-1/client-resources/tasks"},{"title":"Traces","href":"/api-clients/typescript/version-1/client-resources/traces"},{"title":"Users","href":"/api-clients/typescript/version-1/client-resources/users"},{"title":"Webhooks","href":"/api-clients/typescript/version-1/client-resources/webhooks"}]}]},{"group":"Golang SDK","pages":[{"group":"Version 2","pages":[{"title":"Go SDK v2","sidebarTitle":"Overview","href":"/api-clients/go/version-2/overview"},{"title":"AI Integrations","href":"/api-clients/go/version-2/client-resources/ai-integrations"},{"title":"Annotation Configs","href":"/api-clients/go/version-2/client-resources/annotation-configs"},{"title":"Annotation Queues","href":"/api-clients/go/version-2/client-resources/annotation-queues"},{"title":"API Keys","href":"/api-clients/go/version-2/client-resources/api-keys"},{"title":"Audit Logs","href":"/api-clients/go/version-2/client-resources/audit-logs"},{"title":"Datasets","href":"/api-clients/go/version-2/client-resources/datasets"},{"title":"Evaluators","href":"/api-clients/go/version-2/client-resources/evaluators"},{"title":"Experiments","href":"/api-clients/go/version-2/client-resources/experiments"},{"title":"Integrations","href":"/api-clients/go/version-2/client-resources/integrations"},{"title":"Organizations","href":"/api-clients/go/version-2/client-resources/organizations"},{"title":"Projects","href":"/api-clients/go/version-2/client-resources/projects"},{"title":"Prompts","href":"/api-clients/go/version-2/client-resources/prompts"},{"title":"Resource Restrictions","href":"/api-clients/go/version-2/client-resources/resource-restrictions"},{"title":"Role Bindings","href":"/api-clients/go/version-2/client-resources/role-bindings"},{"title":"Roles","href":"/api-clients/go/version-2/client-resources/roles"},{"title":"Spaces","href":"/api-clients/go/version-2/client-resources/spaces"},{"title":"Spans","href":"/api-clients/go/version-2/client-resources/spans"},{"title":"Tasks","href":"/api-clients/go/version-2/client-resources/tasks"},{"title":"Traces","href":"/api-clients/go/version-2/client-resources/traces"},{"title":"Users","href":"/api-clients/go/version-2/client-resources/users"},{"title":"Webhooks","href":"/api-clients/go/version-2/client-resources/webhooks"}]}]},{"group":"CLI","pages":[{"title":"AX CLI","sidebarTitle":"Overview","href":"/api-clients/cli/overview"},{"title":"AI Integrations","href":"/api-clients/cli/ai-integrations"},{"title":"Annotation Configs","href":"/api-clients/cli/annotation-configs"},{"title":"Annotation Queues","href":"/api-clients/cli/annotation-queues"},{"title":"API Keys","href":"/api-clients/cli/api-keys"},{"title":"Auth","href":"/api-clients/cli/auth"},{"title":"Datasets","href":"/api-clients/cli/datasets"},{"title":"Evaluators","href":"/api-clients/cli/evaluators"},{"title":"Experiments","href":"/api-clients/cli/experiments"},{"title":"Instrument","href":"/api-clients/cli/instrument"},{"title":"Integrations","href":"/api-clients/cli/integrations"},{"title":"Organizations","href":"/api-clients/cli/organizations"},{"title":"Profiles","href":"/api-clients/cli/profiles"},{"title":"Projects","href":"/api-clients/cli/projects"},{"title":"Prompts","href":"/api-clients/cli/prompts"},{"title":"Resource Restrictions","href":"/api-clients/cli/resource-restrictions"},{"title":"Role Bindings","href":"/api-clients/cli/role-bindings"},{"title":"Roles","href":"/api-clients/cli/roles"},{"title":"Skills","href":"/api-clients/cli/skills"},{"title":"Spaces","href":"/api-clients/cli/spaces"},{"title":"Spans","href":"/api-clients/cli/spans"},{"title":"Tasks","href":"/api-clients/cli/tasks"},{"title":"Traces","href":"/api-clients/cli/traces"},{"title":"Upgrade","href":"/api-clients/cli/upgrade"},{"title":"Users","href":"/api-clients/cli/users"},{"title":"Webhooks","href":"/api-clients/cli/webhooks"}]},{"group":"Managed Agents CLI","pages":[{"title":"Managed Agents CLI (ag)","sidebarTitle":"Overview","href":"/api-clients/ag/overview"},{"title":"Sessions","href":"/api-clients/ag/sessions"},{"title":"Presets","href":"/api-clients/ag/presets"},{"title":"Skills","href":"/api-clients/ag/skills"},{"title":"Automations","href":"/api-clients/ag/automations"},{"title":"Signal","href":"/api-clients/ag/signal"}]}]}]},{"tab":"Courses","pages":[{"title":"Courses","href":"/ax/learn/courses/overview"}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/ax/concepts/otel-openinference/overview"}]},{"tab":"Self-Hosting","pages":[{"title":"Self-Hosting","href":"/ax/selfhosting"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/ax/release-notes"}]}]},"basePath":"","title":"Annotate a record - Arize AX Docs","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","Page-CBlOSKZG.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}