A VisIQ API key presented as Authorization: Bearer vq_prod_.... Mint harness keys under Settings → Harness Keys and API keys under Settings → API Keys in the dashboard.
The action-schema identity the SDK computed for this event. When omitted, the server derives it from context.
Required string length: 1 - 128
mcp_server
string
The MCP server the tool call came from. A server your registry marks blocked, or one that drifted from its approved definition, is denied whatever the rule outcome.
Required string length: 1 - 255
identity
object
Identity evidence for the event, read by rules as input.session.identity.*. Put a principal in attested only when it came through a channel the agent cannot author (an IdP assertion, your application's own request context, or a check you performed). A principal the model only read in the conversation goes in claimed, which grants nothing. Unknown keys are refused with 400.
Show child attributes
telemetry
object
Response
The enforced decision.
decision_id
string<uuid>
required
decision
enum<string>
required
Available options:
permit,
deny,
approval_required,
mask
reason
string
required
enforced
boolean
required
agent_mode
enum<string>
required
Available options:
off,
monitor,
enforce
rule_code
string | null
The matched rule code (synthetic D-* for defaults; null in off-mode).
plane
enum<string> | null
Available options:
action,
retrieval,
delegation,
null
operation
string | null
is_retrieval
boolean
arg_redaction_rules
object[]
Present only when decision is mask.
hitl_fallback
enum<string>
Present only when decision is approval_required, as the fallback if no human responds.
Available options:
mask,
deny
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VisIQ","colors":{"primary":"#C9165E","light":"#EB508E","dark":"#921044"},"logo":{"light":"https://mintcdn.com/visiqlabs/afZh1dYO5SWUmm2K/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=afZh1dYO5SWUmm2K\u0026q=85\u0026s=a9fd770bff9c0e227a3c6506662df61b","dark":"https://mintcdn.com/visiqlabs/afZh1dYO5SWUmm2K/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=afZh1dYO5SWUmm2K\u0026q=85\u0026s=24904312cf2b0547e04c9e79fb105c88"},"favicon":{"light":"https://mintcdn.com/visiqlabs/afZh1dYO5SWUmm2K/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=afZh1dYO5SWUmm2K\u0026q=85\u0026s=a9fd770bff9c0e227a3c6506662df61b","dark":"https://mintcdn.com/visiqlabs/afZh1dYO5SWUmm2K/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=afZh1dYO5SWUmm2K\u0026q=85\u0026s=24904312cf2b0547e04c9e79fb105c88"},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FDFCFA","dark":"#160C10"}},"navbar":{"links":[{"href":"https://app.visiqlabs.com/dashboard","label":"Dashboard"},{"href":"https://docs.visiqlabs.com/support","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.visiqlabs.com/connectors/api-keys"}},"search":{"prompt":"Search VisIQ docs..."},"fonts":{"heading":{"family":"Archivo"},"body":{"family":"Onest"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"visiqlabs","hasAudioNarration":false,"actualSubdomain":"visiqlabs","customDomains":["docs.visiqlabs.com"],"gitSource":{"type":"github","owner":"visiq-labs","repo":"visiq-platform","deployBranch":"main","contentDirectory":"products/project-y/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aef80e4bc1b65540a854ad8","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":69},{"language":"default","tag":"Endpoints","count":69},{"language":"default","tag":"Quickstart","count":26},{"language":"default","tag":"Records","count":11},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Connectors","count":9},{"language":"default","tag":"Retrieval Rules","count":8},{"language":"default","tag":"Unified Rules","count":7},{"language":"default","tag":"Action Rules","count":6},{"language":"default","tag":"Audit Log","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"assets/custom.css","content":"h1,h2,h3{letter-spacing:-0.02em}h1{font-weight:800!important;letter-spacing:-0.03em}h2{font-weight:700}pre code{font-size:0.875rem;line-height:1.5}html.dark img[src$=\"/assets/icons/vercel-ai-sdk.svg\"],html.dark img[src$=\"/assets/icons/openai-agents-sdk.svg\"],html.dark img[src$=\"/assets/icons/mastra.svg\"]{filter:invert(1)}"}]}
{"page":{"pagePath":"api/evaluation/evaluate-an-agent-action","slug":"/api/evaluation/evaluate-an-agent-action","pageMetadata":{"title":"Evaluate an agent action","description":"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path.\n\nRequires scope `rules:evaluate` (or the legacy `allow:write`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/evaluate","href":"/api/evaluation/evaluate-an-agent-action","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 code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires scope \", _jsx(_components.code, {\n children: \"rules:evaluate\"\n }), \" (or the legacy \", _jsx(_components.code, {\n children: \"allow:write\"\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};\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":{"config":{},"pageMetadata":{"title":"Evaluate an agent action","description":"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path.\n\nRequires scope `rules:evaluate` (or the legacy `allow:write`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/evaluate","href":"/api/evaluation/evaluate-an-agent-action","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"evaluateAction","x-visiq-permission":[],"x-visiq-scopes":["allow:write","rules:evaluate"],"tags":["Evaluation"],"summary":"Evaluate an agent action","description":"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path.\n\nRequires scope `rules:evaluate` (or the legacy `allow:write`).\n","security":["9b05354c-7e57-4bdf-9b25-08fec232bca8"],"requestBody":"8d62faf2-86d8-4801-b337-583433bc7060","responses":{"200":"6b119bba-a99d-4c32-b612-ad39d7ae97e9","400":"a904a1fd-38f0-4594-99ba-18c06961558d","401":"44905ab6-4afe-4813-b529-ca701bdc1f75","403":"ced095ae-82a8-4f39-a38c-68bf9e87b27b","404":"e2f767a9-a408-4bb6-843a-44eaed787162","503":"2f482469-8b39-40c2-8ec0-5eb7281c8ff7"},"method":"post","type":"path","servers":["16bbc297-c4a1-40a0-9e63-a57351006864"],"path":"/allow/evaluate","baseUrlOptions":["https://api.visiqlabs.com"],"title":"Evaluate an agent action","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_id","target_app","action"],"properties":{"agent_id":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"agent_id","typeLabel":"string"},"target_app":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"target_app","typeLabel":"string"},"action":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"action","typeLabel":"string"},"context":{"type":"object","additionalProperties":true,"default":{},"description":"Arbitrary decision inputs (e.g. amount, resource id).","uniqueKey":"context","typeLabel":"object"},"session_id":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"session_id","typeLabel":"string"},"action_schema_id":{"type":"string","minLength":1,"maxLength":128,"description":"The action-schema identity the SDK computed for this event. When omitted, the server derives it from `context`.","uniqueKey":"action_schema_id","typeLabel":"string"},"mcp_server":{"type":"string","minLength":1,"maxLength":255,"description":"The MCP server the tool call came from. A server your registry marks blocked, or one that drifted from its approved definition, is denied whatever the rule outcome.\n","uniqueKey":"mcp_server","typeLabel":"string"},"identity":{"type":"object","additionalProperties":false,"description":"Identity evidence for the event, read by rules as `input.session.identity.*`. Put a principal in `attested` only when it came through a channel the agent cannot author (an IdP assertion, your application's own request context, or a check you performed). A principal the model only read in the conversation goes in `claimed`, which grants nothing. Unknown keys are refused with 400.\n","properties":{"attested":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"identity.attested.items.[INDEX]","typeLabel":"string"},"uniqueKey":"identity.attested","typeLabel":"string[]"},"claimed":{"type":"array","maxItems":32,"items":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"identity.claimed.items.[INDEX]","typeLabel":"string"},"uniqueKey":"identity.claimed","typeLabel":"string[]"},"subject_id":{"type":"string","minLength":1,"maxLength":255,"description":"The person the action acts upon.","uniqueKey":"identity.subject_id","typeLabel":"string"}},"uniqueKey":"identity","typeLabel":"object"},"telemetry":{"type":"object","additionalProperties":true,"uniqueKey":"telemetry","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"agent_id":"billing-copilot","target_app":"stripe","action":"refund.create","context":{"amount_cents":5000}},"examples":{"Example":{"title":"Example","value":{"agent_id":"billing-copilot","target_app":"stripe","action":"refund.create","context":{"amount_cents":5000}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6b119bba-a99d-4c32-b612-ad39d7ae97e9":{"description":"The enforced decision.","content":{"application/json":{"schema":{"type":"object","required":["decision_id","decision","reason","enforced","agent_mode"],"properties":{"decision_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"decision_id","typeLabel":"string\u003cuuid>"},"decision":{"type":"string","enum":["permit","deny","approval_required","mask"],"isRequired":true,"uniqueKey":"decision","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","isRequired":true,"uniqueKey":"reason","typeLabel":"string"},"enforced":{"type":"boolean","isRequired":true,"uniqueKey":"enforced","typeLabel":"boolean"},"agent_mode":{"type":"string","enum":["off","monitor","enforce"],"isRequired":true,"uniqueKey":"agent_mode","typeLabel":"enum\u003cstring>"},"rule_code":{"oneOf":[{"type":"string","description":"The matched rule code (synthetic `D-*` for defaults; null in off-mode).","uniqueKey":"rule_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The matched rule code (synthetic `D-*` for defaults; null in off-mode).","uniqueKey":"rule_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"rule_code","typeLabel":"string | null"},"plane":{"oneOf":[{"type":"string","enum":["action","retrieval","delegation",null],"uniqueKey":"plane.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["action","retrieval","delegation",null],"uniqueKey":"plane.oneOf.1","typeLabel":"null"}],"uniqueKey":"plane","typeLabel":"enum\u003cstring> | null"},"operation":{"oneOf":[{"type":"string","uniqueKey":"operation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"operation.oneOf.1","typeLabel":"null"}],"uniqueKey":"operation","typeLabel":"string | null"},"is_retrieval":{"type":"boolean","uniqueKey":"is_retrieval","typeLabel":"boolean"},"arg_redaction_rules":{"type":"array","description":"Present only when `decision` is `mask`.","items":{"type":"object","additionalProperties":true,"uniqueKey":"arg_redaction_rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"arg_redaction_rules","typeLabel":"object[]"},"hitl_fallback":{"type":"string","enum":["mask","deny"],"description":"Present only when `decision` is `approval_required`, as the fallback if no human responds.","uniqueKey":"hitl_fallback","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"decision_id":"4b2b8c1e-6f2a-4a1e-9e2b-9d5b0a1c2d3e","decision":"permit","reason":"Within policy","rule_code":"R-1042","enforced":true,"agent_mode":"enforce","plane":"action","operation":"create","is_retrieval":false},"examples":{"Example":{"title":"Example","value":{"decision_id":"4b2b8c1e-6f2a-4a1e-9e2b-9d5b0a1c2d3e","decision":"permit","reason":"Within policy","rule_code":"R-1042","enforced":true,"agent_mode":"enforce","plane":"action","operation":"create","is_retrieval":false}}},"exampleType":"examples"}},"exampleType":"examples"},"a904a1fd-38f0-4594-99ba-18c06961558d":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"The standard error envelope. `code` is a stable, machine-readable snake_case identifier on every JSON error: the `error` value itself when that is already an identifier, otherwise a code derived from the HTTP status (see [REST conventions](/reference/rest-conventions)). `details` carries the validation issue list on 400s; authorization failures add fields such as `detail`, `requiredScopes`, or `requiredPermission`.\n","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","description":"Stable machine-readable error code. Branch on this, not on `error`.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"Invalid request body","code":"invalid_request","details":[{"path":["agent_id"],"message":"Required"}]},"examples":{"Example":{"title":"Example","value":{"error":"Invalid request body","code":"invalid_request","details":[{"path":["agent_id"],"message":"Required"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"44905ab6-4afe-4813-b529-ca701bdc1f75":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"The standard error envelope. `code` is a stable, machine-readable snake_case identifier on every JSON error: the `error` value itself when that is already an identifier, otherwise a code derived from the HTTP status (see [REST conventions](/reference/rest-conventions)). `details` carries the validation issue list on 400s; authorization failures add fields such as `detail`, `requiredScopes`, or `requiredPermission`.\n","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","description":"Stable machine-readable error code. Branch on this, not on `error`.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized","code":"unauthenticated"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","code":"unauthenticated"}}},"exampleType":"examples"}},"exampleType":"examples"},"ced095ae-82a8-4f39-a38c-68bf9e87b27b":{"description":"The key lacks the required permission or scope.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"The standard error envelope. `code` is a stable, machine-readable snake_case identifier on every JSON error: the `error` value itself when that is already an identifier, otherwise a code derived from the HTTP status (see [REST conventions](/reference/rest-conventions)). `details` carries the validation issue list on 400s; authorization failures add fields such as `detail`, `requiredScopes`, or `requiredPermission`.\n","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","description":"Stable machine-readable error code. Branch on this, not on `error`.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"insufficient_scope","code":"insufficient_scope","detail":"This API key is not authorized for the requested operation."},"examples":{"Example":{"title":"Example","value":{"error":"insufficient_scope","code":"insufficient_scope","detail":"This API key is not authorized for the requested operation."}}},"exampleType":"examples"}},"exampleType":"examples"},"e2f767a9-a408-4bb6-843a-44eaed787162":{"description":"The requested resource does not exist (or is not visible to this account).","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"The standard error envelope. `code` is a stable, machine-readable snake_case identifier on every JSON error: the `error` value itself when that is already an identifier, otherwise a code derived from the HTTP status (see [REST conventions](/reference/rest-conventions)). `details` carries the validation issue list on 400s; authorization failures add fields such as `detail`, `requiredScopes`, or `requiredPermission`.\n","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","description":"Stable machine-readable error code. Branch on this, not on `error`.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"Rule not found","code":"not_found"},"examples":{"Example":{"title":"Example","value":{"error":"Rule not found","code":"not_found"}}},"exampleType":"examples"}},"exampleType":"examples"},"2f482469-8b39-40c2-8ec0-5eb7281c8ff7":{"description":"A dependency needed to serve the request is unavailable, for example the API-key rate limiter (`rate_limiter_unavailable`) or, for a request that sent an idempotency key, the idempotency store. The request was not processed; retry after the `Retry-After` delay.\n","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer","minimum":0}}},"content":{"application/json":{"schema":{"type":"object","required":["error","code"],"description":"The standard error envelope. `code` is a stable, machine-readable snake_case identifier on every JSON error: the `error` value itself when that is already an identifier, otherwise a code derived from the HTTP status (see [REST conventions](/reference/rest-conventions)). `details` carries the validation issue list on 400s; authorization failures add fields such as `detail`, `requiredScopes`, or `requiredPermission`.\n","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","description":"Stable machine-readable error code. Branch on this, not on `error`.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"rate_limiter_unavailable","code":"rate_limiter_unavailable","detail":"Rate limiter unavailable, please retry."},"examples":{"Example":{"title":"Example","value":{"error":"rate_limiter_unavailable","code":"rate_limiter_unavailable","detail":"Rate limiter unavailable, please retry."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9b05354c-7e57-4bdf-9b25-08fec232bca8":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A VisIQ API key presented as `Authorization: Bearer vq_prod_...`. Mint harness keys under **Settings → Harness Keys** and API keys under **Settings → API Keys** in the dashboard.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"16bbc297-c4a1-40a0-9e63-a57351006864":{"url":"https://api.visiqlabs.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A VisIQ API key presented as `Authorization: Bearer vq_prod_...`. Mint harness keys under **Settings → Harness Keys** and API keys under **Settings → API Keys** in the dashboard.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A VisIQ API key presented as `Authorization: Bearer vq_prod_...`. Mint harness keys under **Settings → Harness Keys** and API keys under **Settings → API Keys** in the dashboard.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"visiqlabs","siteName":"VisIQ","title":"Evaluate an agent action - VisIQ","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T19:50:05.204Z","originalFileLocation":"api/evaluation/evaluate-an-agent-action.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=\"system\"}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=\"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path. Requires scope rules:evaluate (or the legacy allow:write).\">\u003cmeta data-mint-head name=\"application-name\" content=\"VisIQ\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_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=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Evaluate an agent action - VisIQ\">\u003cmeta data-mint-head property=\"og:description\" content=\"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path. Requires scope rules:evaluate (or the legacy allow:write).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VisIQ\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://visiqlabs.mintlify.site/_mintlify/api/og/v2?division=Evaluation\u0026amp;title=Evaluate+an+agent+action\u0026amp;description=Evaluate+a+single+agent+action+against+your+action-governance+rules+and+return+the+enforced+decision.+This+is+the+agent-facing+hot+path.%0A%0ARequires+scope+%60rules%3A\u0026amp;theme=49bf48b285b9e0c24c1bdb9c\u0026amp;signature=7c12d2d036d42347a798cfb43a39c6659b9ce2e72b91dabc45bea82d8ed1e7e8\">\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=\"Evaluate an agent action - VisIQ\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path. Requires scope rules:evaluate (or the legacy allow:write).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://visiqlabs.mintlify.site/_mintlify/api/og/v2?division=Evaluation\u0026amp;title=Evaluate+an+agent+action\u0026amp;description=Evaluate+a+single+agent+action+against+your+action-governance+rules+and+return+the+enforced+decision.+This+is+the+agent-facing+hot+path.%0A%0ARequires+scope+%60rules%3A\u0026amp;theme=49bf48b285b9e0c24c1bdb9c\u0026amp;signature=7c12d2d036d42347a798cfb43a39c6659b9ce2e72b91dabc45bea82d8ed1e7e8\">\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=\"/mintlify-assets/_mintlify/favicons/visiqlabs/v1vYe_GoRw5WVOfg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VisIQ\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#C9165E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/evaluation/evaluate-an-agent-action.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.visiqlabs.com/#organization\",\"name\":\"VisIQ\",\"url\":\"https://docs.visiqlabs.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/visiqlabs/afZh1dYO5SWUmm2K/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=afZh1dYO5SWUmm2K\u0026q=85\u0026s=a9fd770bff9c0e227a3c6506662df61b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.visiqlabs.com#website\",\"name\":\"VisIQ\",\"url\":\"https://docs.visiqlabs.com\",\"publisher\":{\"@id\":\"https://docs.visiqlabs.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action#webpage\",\"url\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action\",\"name\":\"Evaluate an agent action\",\"description\":\"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path. Requires scope rules:evaluate (or the legacy allow:write).\",\"dateModified\":\"2026-11-07T19:50:05.204Z\",\"isPartOf\":{\"@id\":\"https://docs.visiqlabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VisIQ\",\"item\":\"https://docs.visiqlabs.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Evaluate an agent action\",\"item\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action#apireference\",\"headline\":\"Evaluate an agent action\",\"name\":\"Evaluate an agent action\",\"description\":\"Evaluate a single agent action against your action-governance rules and return the enforced decision. This is the agent-facing hot path. Requires scope rules:evaluate (or the legacy allow:write).\",\"url\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action\",\"mainEntityOfPage\":{\"@id\":\"https://docs.visiqlabs.com/api/evaluation/evaluate-an-agent-action#webpage\"},\"dateModified\":\"2026-11-07T19:50:05.204Z\",\"publisher\":{\"@id\":\"https://docs.visiqlabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.visiqlabs.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VisIQ\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"VisIQ\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/evaluation/evaluate-an-agent-action.md","siteName":"VisIQ","nav":{"global":null,"groups":[{"group":"Quickstart","pages":[{"title":"VisIQ — AI Agent Governance SDK","sidebarTitle":"AI Agent Governance SDK","href":"/introduction"},{"title":"Quickstart","sidebarTitle":"Overview","icon":"rocket","href":"/quickstart"},{"title":"AWS Bedrock","sidebarTitle":"AWS Bedrock","href":"/quickstart/aws-bedrock"},{"title":"LangChain Quickstart","sidebarTitle":"LangChain","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/langchain.svg","href":"/quickstart/langchain"},{"title":"Vercel AI SDK Quickstart","sidebarTitle":"Vercel AI SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/vercel-ai-sdk.svg","href":"/quickstart/vercel-ai-sdk"},{"title":"Mastra Quickstart","sidebarTitle":"Mastra","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/mastra.svg","href":"/quickstart/mastra"},{"title":"OpenAI Agents SDK Quickstart","sidebarTitle":"OpenAI Agents SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/openai-agents-sdk.svg","href":"/quickstart/openai-agents-sdk"},{"title":"Semantic Kernel Quickstart","sidebarTitle":"Semantic Kernel","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/semantic-kernel.svg","href":"/quickstart/semantic-kernel"},{"title":"LlamaIndex.TS Quickstart","sidebarTitle":"LlamaIndex.TS","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/llamaindex.svg","href":"/quickstart/llamaindex"},{"title":"VoltAgent Quickstart","sidebarTitle":"VoltAgent","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/voltagent.svg","href":"/quickstart/voltagent"},{"title":"OpenClaw Integration","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/openclaw.svg","href":"/quickstart/openclaw"},{"title":"Claude Code Integration","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/claude-code.svg","href":"/quickstart/claude-code"},{"title":"LangGraph Quickstart","sidebarTitle":"LangGraph","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/langgraph.svg","href":"/quickstart/langgraph"},{"title":"Pydantic AI Quickstart","sidebarTitle":"Pydantic AI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/pydantic-ai.svg","href":"/quickstart/pydantic-ai"},{"title":"Google ADK Quickstart","sidebarTitle":"Google ADK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/google-adk.svg","href":"/quickstart/google-adk"},{"title":"Strands Agents Quickstart","sidebarTitle":"Strands","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/strands.svg","href":"/quickstart/strands"},{"title":"CrewAI Quickstart","sidebarTitle":"CrewAI","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/crewai.svg","href":"/quickstart/crewai"},{"title":"AutoGen Quickstart","sidebarTitle":"AutoGen","icon":"https://mintlify.s3.us-west-1.amazonaws.com/visiqlabs/assets/icons/autogen.svg","href":"/quickstart/autogen"},{"title":"SDK Reference","icon":"book","href":"/reference"},{"title":"REST API conventions","icon":"list-check","href":"/reference/rest-conventions"},{"title":"Python SDK Reference","sidebarTitle":"Python Reference","icon":"book","href":"/reference-python"},{"title":"Go SDK Reference","sidebarTitle":"Go Reference","icon":"book","href":"/reference-go"},{"title":"Java SDK Reference","sidebarTitle":"Java Reference","icon":"book","href":"/reference-java"},{"title":"Ruby SDK Reference","sidebarTitle":"Ruby Reference","icon":"book","href":"/reference-ruby"},{"title":"SDK versioning \u0026 compatibility","icon":"code-branch","href":"/versioning"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","icon":"circle-question","href":"/troubleshooting"}]},{"group":"Action Governance","pages":[{"title":"Action Governance","icon":"shield-check","href":"/rules/action/introduction"},{"title":"Rules","icon":"scale-balanced","href":"/rules/action/rules"},{"title":"Human-in-the-Loop","icon":"user-check","href":"/rules/action/hitl"},{"title":"Kill Switch","icon":"power","href":"/rules/action/kill-switch"},{"title":"API Reference","icon":"code","href":"/rules/action/api-reference"}]},{"group":"Retrieval Governance","pages":[{"title":"Retrieval Governance","icon":"shield-halved","href":"/rules/retrieval/introduction"},{"title":"Rules","icon":"scale-balanced","href":"/rules/retrieval/rules"},{"title":"Emergency Bypass","icon":"triangle-exclamation","href":"/rules/retrieval/emergency-bypass"},{"title":"API Reference","icon":"code","href":"/rules/retrieval/api-reference"}]},{"group":"Delegation Governance","pages":[{"title":"Delegation Governance","icon":"share-nodes","href":"/rules/delegation/introduction"},{"title":"API Reference","icon":"code","href":"/rules/delegation/api-reference"}]},{"group":"Unified Rules","pages":[{"title":"Unified Rules","icon":"layer-group","href":"/rules/unified/introduction"},{"title":"API Reference","icon":"code","href":"/rules/unified/api-reference"}]},{"group":"Audit Trail","pages":[{"title":"Audit Trail","icon":"file-signature","href":"/record/introduction"},{"title":"Decision Receipts","icon":"file-signature","href":"/record/receipts"},{"title":"API Reference","icon":"code","href":"/record/api-reference"}]},{"group":"Discovery","pages":[{"title":"Discovery","sidebarTitle":"Introduction","icon":"radar","href":"/discovery/introduction"},{"title":"Install the Deployed Sensor","sidebarTitle":"Deployed Sensor","icon":"download","href":"/discovery/deployed-sensor"},{"title":"Network requirements for the Deployed Sensor","sidebarTitle":"Network requirements","icon":"network-wired","href":"/discovery/network-requirements"},{"title":"Private windows on macOS","sidebarTitle":"Private windows on macOS","icon":"user-secret","href":"/discovery/macos-private-windows"}]},{"group":"Connectors","pages":[{"title":"Slack approvals","sidebarTitle":"Slack","icon":"slack","href":"/connectors/slack"},{"title":"Email approvals","sidebarTitle":"Email","icon":"envelope","href":"/connectors/email"},{"title":"Stream logs to Datadog","sidebarTitle":"Datadog","icon":"dog","href":"/connectors/datadog"},{"title":"Stream logs to Elasticsearch","sidebarTitle":"Elasticsearch","icon":"magnifying-glass","href":"/connectors/elastic"},{"title":"Stream logs to Rapid7","sidebarTitle":"Rapid7 InsightIDR","icon":"shield","href":"/connectors/rapid7"},{"title":"Install the Context Firewall extension","sidebarTitle":"Context Firewall","icon":"shield-check","href":"/connectors/context-firewall"},{"title":"Secure ChatGPT","sidebarTitle":"ChatGPT","icon":"shield-check","href":"/connectors/chatgpt"},{"title":"Secure Gemini","sidebarTitle":"Gemini","icon":"shield-check","href":"/connectors/gemini"},{"title":"Secure Microsoft Copilot","sidebarTitle":"Microsoft Copilot","icon":"shield-check","href":"/connectors/microsoft-copilot"}]},{"group":"API Examples","pages":[{"title":"API Examples — Notebooks","icon":"flask","href":"/examples/notebooks"}]},{"group":"Platform Automation","pages":[{"title":"Platform Automation","icon":"robot","href":"/automation/introduction"},{"title":"Managing API Keys","icon":"key","href":"/automation/api-keys"},{"title":"Agent self-registration","icon":"id-card","href":"/automation/agent-device-flow"},{"title":"Platform MCP server","icon":"plug","href":"/automation/mcp"}]},{"group":"Partners","pages":[{"title":"OEM Partner API","icon":"layer-group","href":"/partners/oem-api"},{"title":"Sandbox mode","icon":"flask","href":"/partners/oem-sandbox"},{"title":"Versioning \u0026 deprecation","icon":"code-branch","href":"/partners/oem-versioning"},{"title":"White-Label Walkthrough","icon":"paintbrush","href":"/partners/white-label"}]},{"group":"Reference","pages":[{"title":"Authentication","icon":"lock","href":"/authentication"},{"title":"Glossary","icon":"book-open","href":"/glossary"},{"title":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"title":"Support","description":"How to reach the VisIQ team — email, the in-product dashboard, and where to file the details that get you a fast answer.","icon":"life-ring","href":"/support"}]},{"group":"API Reference","pages":[{"group":"Endpoints","pages":[{"group":"Evaluation","pages":[{"title":"Evaluate an agent action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/evaluate","href":"/api/evaluation/evaluate-an-agent-action"},{"title":"Evaluate a retrieval","description":"Evaluate a retrieval, tool call, or prompt render against your retrieval-governance rules and return the enforced decision (with mask directives when the decision is `redact`).\n\nRequires scope `rules:evaluate` (or the legacy `recall:write`).\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /recall/evaluate","href":"/api/evaluation/evaluate-a-retrieval"},{"title":"Evaluate a governed event (unified)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /evaluate","href":"/api/evaluation/evaluate-a-governed-event-unified"},{"title":"Enforce a delegated action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /orchestrate/evaluate","href":"/api/evaluation/enforce-a-delegated-action"}]},{"group":"Action Rules","pages":[{"title":"List action rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/rules","href":"/api/action-rules/list-action-rules"},{"title":"Create an action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/rules","href":"/api/action-rules/create-an-action-rule"},{"title":"Compile an action rule from natural language","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/rules/compile","href":"/api/action-rules/compile-an-action-rule-from-natural-language"},{"title":"Get an action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/rules/{id}","href":"/api/action-rules/get-an-action-rule"},{"title":"Update an action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /allow/rules/{id}","href":"/api/action-rules/update-an-action-rule"},{"title":"Delete an action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /allow/rules/{id}","href":"/api/action-rules/delete-an-action-rule"}]},{"group":"Retrieval Rules","pages":[{"title":"List retrieval rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /recall/rules","href":"/api/retrieval-rules/list-retrieval-rules"},{"title":"Create a retrieval rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /recall/rules","href":"/api/retrieval-rules/create-a-retrieval-rule"},{"title":"Compile a retrieval rule from natural language","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /recall/rules/compile","href":"/api/retrieval-rules/compile-a-retrieval-rule-from-natural-language"},{"title":"Get a retrieval rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /recall/rules/{id}","href":"/api/retrieval-rules/get-a-retrieval-rule"},{"title":"Update a retrieval rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /recall/rules/{id}","href":"/api/retrieval-rules/update-a-retrieval-rule"},{"title":"Delete a retrieval rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /recall/rules/{id}","href":"/api/retrieval-rules/delete-a-retrieval-rule"},{"title":"Activate emergency bypass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /recall/rules/{id}/bypass","href":"/api/retrieval-rules/activate-emergency-bypass"},{"title":"Deactivate emergency bypass","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /recall/rules/{id}/bypass","href":"/api/retrieval-rules/deactivate-emergency-bypass"}]},{"group":"Unified Rules","pages":[{"title":"List rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /rules","href":"/api/unified-rules/list-rules"},{"title":"Create a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /rules","href":"/api/unified-rules/create-a-rule"},{"title":"Get a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /rules/{id}","href":"/api/unified-rules/get-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /rules/{id}","href":"/api/unified-rules/update-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /rules/{id}","href":"/api/unified-rules/delete-a-rule"}]},{"group":"Rule Bundles","pages":[{"title":"Get the action rule bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/rules/bundle","href":"/api/rule-bundles/get-the-action-rule-bundle"},{"title":"Retired. Use GET /rules/bundle","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml get /recall/rules/bundle","href":"/api/rule-bundles/retired-use-get-rulesbundle"},{"title":"Get the unified rule bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /rules/bundle","href":"/api/rule-bundles/get-the-unified-rule-bundle"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/agents","href":"/api/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/agents","href":"/api/agents/create-an-agent"},{"title":"Register agent environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/agents/register","href":"/api/agents/register-agent-environment"},{"title":"Report agent tool surface","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/agents/tools","href":"/api/agents/report-agent-tool-surface"},{"title":"Report installed agent skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/agents/skills","href":"/api/agents/report-installed-agent-skills"},{"title":"Stream agent mode changes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/agents/me/stream","href":"/api/agents/stream-agent-mode-changes"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/agents/{id}","href":"/api/agents/get-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /allow/agents/{id}","href":"/api/agents/update-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /allow/agents/{id}","href":"/api/agents/delete-an-agent"},{"title":"Regenerate an agent's AI name","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/agents/{id}/regenerate-naming","href":"/api/agents/regenerate-an-agents-ai-name"}]},{"group":"Human-in-the-loop","pages":[{"title":"List the approval queue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/hitl/queue","href":"/api/human-in-the-loop/list-the-approval-queue"},{"title":"Create an approval request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/hitl/queue","href":"/api/human-in-the-loop/create-an-approval-request"},{"title":"Respond to an approval request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/hitl/queue/{id}","href":"/api/human-in-the-loop/respond-to-an-approval-request"}]},{"group":"Settings","pages":[{"title":"Get governance settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /allow/settings","href":"/api/settings/get-governance-settings"},{"title":"Update governance settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /allow/settings","href":"/api/settings/update-governance-settings"}]},{"group":"Telemetry","pages":[{"title":"Report locally-evaluated decisions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/telemetry","href":"/api/telemetry/report-locally-evaluated-decisions"},{"title":"Record an action's execution outcome","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/execution-events","href":"/api/telemetry/record-an-actions-execution-outcome"}]},{"group":"Cognition","pages":[{"title":"Ingest cognition beats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/cognition","href":"/api/cognition/ingest-cognition-beats"},{"title":"Reveal a retained cognition value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/cognition/reveal","href":"/api/cognition/reveal-a-retained-cognition-value"},{"title":"Query captured cognition sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/allow/cognition/sessions","href":"/api/cognition/query-captured-cognition-sessions"},{"title":"Query cognition beats (events)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/allow/cognition/events","href":"/api/cognition/query-cognition-beats-events"}]},{"group":"Key lifecycle","pages":[{"title":"Revoke the calling API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /allow/self/revoke","href":"/api/key-lifecycle/revoke-the-calling-api-key"}]},{"group":"Delegation","pages":[{"title":"Create a delegation grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /orchestrate/grants","href":"/api/delegation/create-a-delegation-grant"},{"title":"Get grant status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /orchestrate/grants/{id}","href":"/api/delegation/get-grant-status"},{"title":"Accept a delegation grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /orchestrate/grants/{id}/accept","href":"/api/delegation/accept-a-delegation-grant"},{"title":"Revoke a delegation grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /orchestrate/grants/{id}/revoke","href":"/api/delegation/revoke-a-delegation-grant"}]},{"group":"Records","pages":[{"title":"Ingest a record envelope","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /record/envelopes","href":"/api/records/ingest-a-record-envelope"},{"title":"Verify a record envelope","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/envelopes/{id}/verify","href":"/api/records/verify-a-record-envelope"},{"title":"List records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/records","href":"/api/records/list-records"},{"title":"Get a record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/records/{id}","href":"/api/records/get-a-record"},{"title":"Finalize a record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /record/records/{id}/finalize","href":"/api/records/finalize-a-record"},{"title":"List record events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/records/{id}/events","href":"/api/records/list-record-events"},{"title":"List record artifacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/records/{id}/artifacts","href":"/api/records/list-record-artifacts"},{"title":"List record attestations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/records/{id}/attestations","href":"/api/records/list-record-attestations"},{"title":"List transparency-log checkpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/checkpoints","href":"/api/records/list-transparency-log-checkpoints"},{"title":"Get a checkpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/checkpoints/{seq}","href":"/api/records/get-a-checkpoint"},{"title":"Verify hash-chain consistency","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /record/chain/consistency","href":"/api/records/verify-hash-chain-consistency"}]},{"group":"Audit Log","pages":[{"title":"Get a retrieval decision receipt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /recall/receipts/{id}","href":"/api/audit-log/get-a-retrieval-decision-receipt"},{"title":"Reveal a retrieval decision's original payload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /recall/decisions/{id}/unmask","href":"/api/audit-log/reveal-a-retrieval-decisions-original-payload"},{"title":"Query the action decision log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/allow/audit-log","href":"/api/audit-log/query-the-action-decision-log"},{"title":"Get a single action decision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/allow/decisions/{id}","href":"/api/audit-log/get-a-single-action-decision"},{"title":"Query the retrieval decision log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/recall/audit-log","href":"/api/audit-log/query-the-retrieval-decision-log"},{"title":"Query the record event log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/record/audit-log","href":"/api/audit-log/query-the-record-event-log"}]}]}]}]},"basePath":"","title":"Evaluate an agent action - VisIQ","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}