Errors

Every error response carries the same envelope, error: a stable code, a human-readable message, details naming each field involved, and a doc_url pointing at the section below.

AGENT_AUTHORING_VIA_DRAFTS

HTTP 403 · Returned by State sentences as a policy

AGENT_NOT_FOUND

HTTP 404 · Returned by Read one ratified policy, Create a hand-made org unit, Create the autonomy zone on an org unit

What happened: No agent with that id exists in your organization.

What to do: List your agents to find the right id.

AI_NOT_ENABLED

HTTP 409 · Returned by Start a draft from a source or a preset, Ask for a fix, Read AIP authoring metadata, State sentences as a policy, Edit a policy: open its edit draft

What happened: AIP authoring has no AI model it can use: its task is not configured, is disabled or has no default model, or your organization has no enabled AI provider.

What to do: Ask an admin to enable an AI provider and to set up AIP authoring with a default model, then retry.

ALREADY_ANSWERED

HTTP 409 · Returned by Answer ask

What happened: This item was already answered.

What to do: Read the item for its current state; there is nothing left to answer.

ALREADY_ATTACHED

HTTP 409 · Console only: no public API operation returns it

What happened: The policy is already attached to this Autonomy Zone.

What to do: Nothing to do: the policy is already in the zone.

ALREADY_CURRENT

HTTP 409 · Returned by Apply an earlier version of a policy

What happened: The version you asked to apply is already the one in force.

What to do: Nothing to do: that version already applies.

ALREADY_MEMBER

HTTP 409 · Console only: no public API operation returns it

ALREADY_SUPERADMIN

HTTP 409 · Console only: no public API operation returns it

ASSIGNMENT_BUSY

HTTP 409 · Returned by Create a hand-made org unit, Create the autonomy zone on an org unit

What happened: Another zone assignment change for these agents is still running.

What to do: Wait a moment, then retry.

BAD_GATEWAY

HTTP 502 · Returned by Override, link or reset an agent's ownership

What happened: A service the operation depends on answered with an error.

What to do: Retry later. If it persists, contact support with the time of the request.

BAD_REQUEST

HTTP 400 · Returned by 45 operations

Show the operations

• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Ask for a fix
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Dismiss a security alert
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Apply an earlier version of a policy
• Copy a policy to a zone
• State sentences as a policy
• Edit a policy: open its edit draft
• Promote a policy to Enforce on the strength of an anomaly
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Rename or describe an organization preset
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Snooze ask
• Patch anomaly
• Add values to a dictionary table
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The request could not be read.

What to do: Check the method, the path, the parameters and that the body is valid JSON.

CASE_NOT_LEARNED

HTTP 409 · Returned by Remove a learned case

CLIENT_UPGRADE_REQUIRED

HTTP 400 · Console only: no public API operation returns it

CONFLICT

HTTP 409 · Returned by Start a draft from a source or a preset, Restore an archived (dismissed) security alert, Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone

What happened: The request conflicts with the current state of the resource.

What to do: Read the resource again, then retry against its current state.

DEFAULT_CONFLICT

HTTP 409 · Returned by Revert the default zone to the root, Make a zone the organization's default zone

What happened: The request conflicts with the organization's default zone.

What to do: Read the zones for the current default, then retry.

DEPTH_EXCEEDED

HTTP 422 · Returned by Create a hand-made org unit, Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: The org unit tree would become deeper than allowed.

What to do: Place the unit under a parent higher in the tree.

DICTIONARY_TABLE_EXISTS

HTTP 409 · Returned by Ratify and activate a draft, Apply an earlier version of a policy, Add a dictionary table to a zone

DICTIONARY_TABLE_IN_USE

HTTP 409 · Returned by Delete one of a zone's own dictionary tables

DIRECTORY_OWNED

HTTP 409 · Returned by Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: This org unit comes from your identity directory and cannot be changed here.

What to do: Change it in your directory, or act on a hand-made unit.

DRAFT_EXISTS

HTTP 409 · Returned by Edit a policy: open its edit draft

What happened: A draft version of this policy is already open.

What to do: Finish or discard that draft before opening another.

DRAFT_NOT_PREPARED

HTTP 409 · Returned by Ratify and activate a draft

DRAFT_REVISION_STALE

HTTP 409 · Returned by Prepare a revision of a draft

EDIT_DRAFT_STALE

HTTP 409 · Returned by Ratify and activate a draft

EMPTY_PATCH

HTTP 422 · Returned by Save the zones, the mode and the Ask overrides of a draft, Edit one intent policy of a draft, Set a policy's Ask delivery and Ask behaviour, Rename or describe an organization preset, Set a zone's Ask settings

What happened: The request changes nothing.

What to do: Send at least one field to change.

ENGINE_UNAVAILABLE

HTTP 503 · Returned by 12 operations

Show the operations

• Answer one interview card
• Ratify and activate a draft
• Accept a learning proposal
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Change the mode of a policy in one Autonomy Zone
• Anomaly detail
• Add values to a dictionary table
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent

What happened: The policy engine could not answer in time.

What to do: Wait for the number of seconds in the Retry-After header, then retry.

EVIDENCE_ARCHIVED

HTTP 422 · Console only: no public API operation returns it

What happened: The evidence you named is archived and can no longer be used.

What to do: Name evidence that is still current.

EVIDENCE_EXPIRED

HTTP 409 · Returned by Answer ask

What happened: The evidence behind this item has expired.

What to do: Read the item again for its current state.

EVIDENCE_POLICY_MISMATCH

HTTP 422 · Console only: no public API operation returns it

What happened: The evidence you named belongs to another policy.

What to do: Name evidence recorded for this policy.

EVIDENCE_UNAVAILABLE

HTTP 503 · Returned by Promote a policy to Enforce on the strength of an anomaly

What happened: The evidence could not be read right now.

What to do: Wait for the number of seconds in the Retry-After header, then retry.

FEATURE_DISABLED

HTTP 403 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

FEATURE_STATE_UNAVAILABLE

HTTP 503 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

FIX_ATTEMPTS_EXHAUSTED

HTTP 409 · Returned by Ask for a fix

FIX_NOT_AVAILABLE

HTTP 409 · Returned by Apply a drafted fix

FORBIDDEN

HTTP 403 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The key's role is below the operation's minimum role.

What to do: Use a key whose owner holds a role the operation page allows.

GOVERNOR_SIGNATURE_INVALID

HTTP 401 · Console only: no public API operation returns it

GRANT_ENDED

HTTP 409 · Console only: no public API operation returns it

GROUNDING_IN_FLIGHT

HTTP 409 · Returned by 7 operations

Show the operations

• Answer one interview card
• Apply a drafted fix
• Take one intent policy out of a draft
• Ask for a fix
• Edit one intent policy of a draft
• Prepare a revision of a draft
• Set the verdict a case should get

HOST_CONFLICT

HTTP 409 · Console only: no public API operation returns it

HOST_CUT_OFF

HTTP 403 · Console only: no public API operation returns it

HOST_DEENROLLED

HTTP 403 · Console only: no public API operation returns it

HOST_ID_REQUIRED

HTTP 400 · Console only: no public API operation returns it

HOST_INSTANCE_INVALID

HTTP 400 · Console only: no public API operation returns it

HOST_MISMATCH

HTTP 403 · Console only: no public API operation returns it

HOST_REVOKED

HTTP 401 · Console only: no public API operation returns it

IDEMPOTENCY_IN_PROGRESS

HTTP 409 · Returned by 56 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Ratify and activate a draft
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Apply an earlier version of a policy
• Copy a policy to a zone
• State sentences as a policy
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Snooze ask
• Patch anomaly
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: A request with this Idempotency-Key is still running.

What to do: Wait for it to finish, then retry with the same key to read its result.

IDEMPOTENCY_KEY_REUSED

HTTP 422 · Returned by 61 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Apply an earlier version of a policy
• Copy a policy to a zone
• State sentences as a policy
• Edit a policy: open its edit draft
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Snooze ask
• Patch anomaly
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: This Idempotency-Key was already used with a different request.

What to do: Send a new key for a new request; reuse a key only to retry the same request.

INHERITED_HERE

HTTP 409 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Delete a policy, Set a policy's Ask delivery and Ask behaviour, Change the mode of a policy in one Autonomy Zone

What happened: The setting is inherited from a layer above, so it cannot be changed here.

What to do: Change it on the layer where the policy was authored.

INHERITED_VALUE

HTTP 409 · Returned by Delete one of a zone's own dictionary tables, Delete one of a zone's own dictionary values

INSUFFICIENT_SCOPE

HTTP 403 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The API key lacks the scope the operation needs. details names it as required_scope, or none when the operation is not available to scoped keys.

What to do: Use a key that holds the scope required_scope names. API key scopes lists what each scope covers.

INTERNAL_SERVER_ERROR

HTTP 500 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: Something failed on the OpenLatch side.

What to do: Retry later. If it persists, contact support with the time of the request.

INVALID_BODY

HTTP 422 · Returned by Start a draft from a source or a preset, Ingest a source document, Edit one intent policy of a draft, Set the verdict a case should get

What happened: The request body does not match what the operation accepts.

What to do: Check the request body on the operation page.

INVALID_ID

HTTP 422 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

INVALID_MULTIPART

HTTP 422 · Returned by Ingest a source document

What happened: The multipart upload could not be read.

What to do: Send the parts the operation page names.

INVALID_NAME

HTTP 422 · Returned by Add a dictionary table to a zone, Create a hand-made org unit, Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: The name is empty, too long or uses characters that are not allowed.

What to do: Choose another name.

INVALID_OBSERVATION

HTTP 422 · Returned by Add a dictionary table to a zone

INVALID_PATTERN

HTTP 422 · Returned by Answer one interview card, Ratify and activate a draft, Accept a learning proposal, Apply an earlier version of a policy, Add values to a dictionary table

JOB_ALREADY_EXISTS

HTTP 409 · Returned by 8 operations

Show the operations

• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Ask for a fix
• Edit one intent policy of a draft
• Prepare a revision of a draft
• Replay a draft over past executions
• Edit a policy: open its edit draft

What happened: The same request is already queued under this Idempotency-Key.

What to do: Read the job id returned in details instead of creating another.

LEGACY_KEY_NOT_ROTATABLE

HTTP 409 · Console only: no public API operation returns it

What happened: Rotate on a legacy key

What to do: Narrow this key to a preset or custom scopes before rotating it.

LOOSENS_LAYER

HTTP 409 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone, Remove a hand-made org unit, Retire an autonomy zone

What happened: The change would loosen a policy set by a layer above.

What to do: Keep the policy at least as strict as the layers above.

METHOD_NOT_ALLOWED

HTTP 405 · Console only: no public API operation returns it

What happened: The path exists but does not accept this HTTP method.

What to do: Check the method on the operation page.

NOTHING_RATIFIED

HTTP 422 · Returned by Ratify and activate a draft

NOT_ACTIVATABLE

HTTP 409 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone

What happened: The policy is not in force, or has nothing it could enforce.

What to do: Read the policy's status before changing its mode.

NOT_ATTACHED

HTTP 409 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone

What happened: The policy is not attached to this Autonomy Zone.

What to do: Read the zone's policies, then retry with one that is attached.

NOT_DEFAULT

HTTP 409 · Returned by Revert the default zone to the root

What happened: The zone you named is not the default zone.

What to do: Read the zones for the current default.

NOT_FOUND

HTTP 404 · Returned by 82 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: Nothing with that id exists in your organization.

What to do: Check the id, or list the resources to find the right one.

NOT_PENDING

HTTP 409 · Returned by Answer hold, Snooze ask

What happened: The item is no longer waiting for an answer.

What to do: Read it again for its current state.

NOT_RATIFIED

HTTP 409 · Returned by 10 operations

Show the operations

• Accept a learning proposal
• Apply an earlier version of a policy
• Copy a policy to a zone
• Edit a policy: open its edit draft
• Promote a policy to Enforce on the strength of an anomaly
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Add rules to an organization preset
• Create an organization preset

What happened: The policy version was never ratified.

What to do: Ratify the draft first, or name a ratified version.

NO_FAILING_CASE

HTTP 409 · Returned by Ask for a fix

NO_ZONE

HTTP 422 · Returned by Ratify and activate a draft, State sentences as a policy

ONE_ZONE_PER_AIP

HTTP 409 · Returned by Save the zones, the mode and the Ask overrides of a draft, Ratify and activate a draft, State sentences as a policy

What happened: The policy already sits in another Autonomy Zone, and a policy sits in one zone at most.

What to do: Remove it from its zone first, or write a separate policy for this zone.

OPERATION_REMOVED

HTTP 410 · Returned by Add policies to an Autonomy Zone (removed), Remove a policy from an Autonomy Zone (removed)

ORG_NOT_IN_STATE

HTTP 409 · Console only: no public API operation returns it

OWNER_EMAIL_AMBIGUOUS

HTTP 422 · Returned by Override, link or reset an agent's ownership

What happened: The email matches more than one person in your directory.

What to do: Name the owner by person id instead.

PAYLOAD_TOO_LARGE

HTTP 413 · Returned by Ingest a source document

What happened: The request body is larger than the operation accepts.

What to do: Send a smaller source, or split it.

POLICY_VERSION_REQUIRED

HTTP 428 · Returned by Promote a policy to Enforce on the strength of an anomaly, Delete a policy, Change the mode of a policy in one Autonomy Zone

POLICY_VERSION_STALE

HTTP 409 · Returned by Promote a policy to Enforce on the strength of an anomaly, Delete a policy, Change the mode of a policy in one Autonomy Zone

PRESET_CHANGED

HTTP 409 · Returned by Start a draft from a source or a preset, Add rules to an organization preset, Create an organization preset, Remove a rule from an organization preset, Rename or describe an organization preset

PRESET_EMPTY

HTTP 422 · HTTP 409 · Returned by Create an organization preset, Remove a rule from an organization preset

PRESET_NAME_EXISTS

HTTP 409 · Returned by Create an organization preset, Rename or describe an organization preset

PRESET_READ_ONLY

HTTP 409 · Returned by Add rules to an organization preset, Delete an organization preset, Remove a rule from an organization preset, Rename or describe an organization preset

PROOF_UNAVAILABLE

HTTP 503 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone, Remove a hand-made org unit, Retire an autonomy zone

What happened: The check that the change keeps every layer above as strict could not finish.

What to do: Wait for the number of seconds in the Retry-After header, then retry.

PROPOSAL_CLOSED

HTTP 409 · Returned by Accept a learning proposal, Dismiss a learning proposal

PROPOSAL_STALE

HTTP 409 · Returned by Accept a learning proposal

RELAY_PROVENANCE_REQUIRED

HTTP 403 · Console only: no public API operation returns it

What happened: The request did not arrive through the OpenLatch edge.

What to do: Call the operation at the public API base URL.

RETIRED

HTTP 409 · Returned by Copy a policy to a zone, Answer ask

What happened: The policy behind this item is retired.

What to do: Nothing to answer; read the zone's current policies.

ROOT_UNIT

HTTP 409 · Returned by Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: The root org unit cannot be changed or removed.

What to do: Act on one of its children.

ROOT_ZONE

HTTP 409 · Returned by Remove a hand-made org unit, Retire an autonomy zone

What happened: The root zone cannot be retired.

What to do: Act on another zone.

SAME_LAYER_CONFLICT

HTTP 409 · Returned by Accept a learning proposal, Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone, Remove a hand-made org unit, Retire an autonomy zone

What happened: Another policy on the same layer already sets this.

What to do: Change or detach the other policy first.

SCOPES_REQUIRED

HTTP 422 · Console only: no public API operation returns it

What happened: Create without scopes, or with []

What to do: Choose a preset or at least one scope for this key.

SCOPE_EXCEEDS_ROLE

HTTP 422 · Console only: no public API operation returns it

What happened: A personal key given a scope its owner's role cannot use; details[].field = "scopes" names it

What to do: Your role cannot use the <scope> scope. Remove it, or ask an admin for an organization key.

SCOPE_NOT_GRANTABLE

HTTP 422 · Console only: no public API operation returns it

What happened: The scopes list of a key holds a value that key cannot be granted: legacy or self on any key, host:enroll or host:run on a personal key.

What to do: Remove that value and choose scopes from API key scopes. Every key already holds self.

SCOPE_UNAVAILABLE

HTTP 422 · Returned by Answer ask

What happened: The scope you chose for the answer is not available for this item.

What to do: Choose another scope.

SELECTION_REQUIRED

HTTP 422 · Console only: no public API operation returns it

What happened: The request names no agent.

What to do: Select at least one agent.

SELECTION_TOO_LARGE

HTTP 422 · Returned by Save the zones, the mode and the Ask overrides of a draft, Add rules to an organization preset, Create an organization preset, Create a hand-made org unit, Create the autonomy zone on an org unit

What happened: The request names more agents than one call accepts.

What to do: Split the selection into smaller requests.

SENTENCES_MISMATCH

HTTP 409 · Returned by Ratify and activate a draft, Apply an earlier version of a policy

What happened: The sentences sent are not the ones this request puts in force. The comparison ignores their order, extra whitespace and the way Unicode composes a character, and nothing else.

What to do: Read the draft or the version again, show the person approving what it holds now, and send exactly those sentences.

SENTENCES_REQUIRED

HTTP 428 · Returned by Ratify and activate a draft, Apply an earlier version of a policy

What happened: The request sent no sentences. Ratifying a draft or applying an earlier version must send the exact sentences it puts in force.

What to do: Read the draft or the version, show its sentences to the person approving, then send them with the request.

SERVICE_UNAVAILABLE

HTTP 503 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The service is temporarily unavailable.

What to do: Wait for the number of seconds in the Retry-After header, then retry.

SITE_MISMATCH

HTTP 421 · Console only: no public API operation returns it

What happened: The request reached a site that does not hold your organization.

What to do: Call the public API base URL so the request reaches your site.

STALE_EXPECTED

HTTP 409 · Console only: no public API operation returns it

SUPERADMIN_ORG_MISSING

HTTP 409 · Console only: no public API operation returns it

SUPPORT_GRANT_MEMBER

HTTP 409 · Console only: no public API operation returns it

SUPPORT_GRANT_RESTRICTED

HTTP 403 · Console only: no public API operation returns it

TOO_MANY_REQUESTS

HTTP 429 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The organization went over its rate limit.

What to do: Wait for the number of seconds in the Retry-After header, then retry.

UNAUTHORIZED

HTTP 401 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The request carried no API key, or the key is revoked or expired.

What to do: Send a valid key in the Authorization header, as Bearer followed by the key.

UNIT_CYCLE

HTTP 409 · Returned by Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: The move would make an org unit its own ancestor.

What to do: Choose a parent outside the unit's own subtree.

UNIT_EXISTS

HTTP 409 · Returned by Create a hand-made org unit, Remove a hand-made org unit, Rename and/or reparent a hand-made org unit

What happened: An org unit with that name already exists under this parent.

What to do: Choose another name or another parent.

UNKNOWN_ACTION_ID

HTTP 422 · Console only: no public API operation returns it

What happened: The action id you named does not exist.

What to do: Check the id against the execution graph.

UNKNOWN_CARD

HTTP 422 · Returned by Answer one interview card

UNKNOWN_EVIDENCE

HTTP 422 · Console only: no public API operation returns it

What happened: The evidence you named does not exist.

What to do: Check the evidence id.

UNKNOWN_FIELD_ID

HTTP 422 · Console only: no public API operation returns it

What happened: The field id you named does not exist.

What to do: Check the field id.

UNKNOWN_SCOPE

HTTP 422 · Console only: no public API operation returns it

What happened: The scopes list of a key holds a value that is not a scope name.

What to do: Choose scope names from API key scopes.

UNKNOWN_VERSION

HTTP 422 · Returned by Edit a policy: open its edit draft

What happened: The policy version you named does not exist.

What to do: Read the policy for its versions.

UNREADABLE_SOURCE

HTTP 422 · Returned by Ingest a source document

What happened: The source document could not be read.

What to do: Send readable text, or a file in a supported format.

UNSUPPORTED_MEDIA_TYPE

HTTP 415 · Returned by Ingest a source document

What happened: The request's content type is not one the operation accepts.

What to do: Send the content type the operation page names.

VALIDATION_ERROR

HTTP 422 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: A parameter or a body field failed validation.

What to do: Read details: each entry names the field and the rule it broke.

ZONE_EXISTS

HTTP 409 · Returned by Create the autonomy zone on an org unit, Who would arrive if this unit's Autonomy Zone were enabled

What happened: This org unit already carries an Autonomy Zone.

What to do: Act on the existing zone.

ZONE_FIXED

HTTP 409 · Console only: no public API operation returns it

ZONE_NOT_FOUND

HTTP 404 · Returned by Copy a policy to a zone, Revert the default zone to the root, Remove a hand-made org unit, Retire an autonomy zone, Make a zone the organization's default zone

What happened: No Autonomy Zone with that id exists in your organization.

What to do: List the zones to find the right id.

ZONE_REQUIRED

HTTP 409 · Returned by Promote a policy to Enforce on the strength of an anomaly, Change the mode of a policy in one Autonomy Zone

What happened: The policy is in no zone or in several, and the request did not say which.

What to do: Name the zone.

ZONE_UNAVAILABLE

HTTP 422 · Returned by 6 operations

Show the operations

• Start a draft from a source or a preset
• Save the zones, the mode and the Ask overrides of a draft
• Ratify and activate a draft
• Copy a policy to a zone
• State sentences as a policy
• Assign an agent to a zone by hand

What happened: The zone you named cannot be used for this request.

What to do: Choose another zone.

license_expired

HTTP 402 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: Your organization's license has expired.

What to do: Ask your OpenLatch administrator to renew the license.

tenant_isolation_violation

HTTP 500 · Returned by 94 operations

Show the operations

• Delete an agent and cascade to all its sessions, events, and stats.
• Get a single agent by ID
• Execution graph for one agent
• Events under one execution-graph node
• Read an agent's ownership
• Read the full privilege grant list of an agent's owner
• List agents connected to the authenticated organization
• Queue an immediate ownership re-resolution
• Update editable fields on an agent (currently: display_name).
• Override, link or reset an agent's ownership
• Answer one interview card
• Apply a drafted fix
• Start a draft from a source or a preset
• Ingest a source document
• Discard a draft
• Take one intent policy out of a draft
• Ask for a fix
• Read AIP authoring metadata
• One draft and its intent policies
• Save the zones, the mode and the Ask overrides of a draft
• Edit one intent policy of a draft
• Poll one authoring job
• Prepare a revision of a draft
• Ratify and activate a draft
• Replay a draft over past executions
• Set the verdict a case should get
• Hard-delete a single security alert
• Dismiss a security alert
• List security alerts
• Mark a security alert as read
• Mark a security alert as unread
• Restore an archived (dismissed) security alert
• Accept a learning proposal
• Dismiss a learning proposal
• Read a learning proposal
• List learning proposals
• Apply an earlier version of a policy
• Add policies to an Autonomy Zone (removed)
• Copy a policy to a zone
• State sentences as a policy
• Remove a policy from an Autonomy Zone (removed)
• Edit a policy: open its edit draft
• Read one ratified policy
• The policies in force at one zone
• Promote a policy to Enforce on the strength of an anomaly
• Remove a learned case
• Delete a policy
• Revoke an intent policy's decisive mark
• Set a policy's Ask delivery and Ask behaviour
• Change the mode of a policy in one Autonomy Zone
• Rename a policy
• Add rules to an organization preset
• Create an organization preset
• Delete an organization preset
• List policy presets
• Remove a rule from an organization preset
• Rename or describe an organization preset
• Delete every session (and its events) for a specific agent.
• Delete a session and cascade to all events and stats for that session.
• Summarize an agent's sessions
• List sessions for a specific agent
• Org-wide sessions inventory (every session across all agents, no dedup)
• Update editable fields on a session (currently: display_name).
• Answer ask
• Answer hold
• Anomaly detail
• Anomalies
• List asks
• List holds
• Snooze ask
• Patch anomaly
• Get the calling user's context
• Add values to a dictionary table
• Revert the default zone to the root
• Add a dictionary table to a zone
• Create a hand-made org unit
• Create the autonomy zone on an org unit
• Reset an agent to automatic zone assignment
• Delete one of a zone's own dictionary tables
• Delete one of a zone's own dictionary values
• Remove a hand-made org unit
• Retire an autonomy zone
• What governs this agent
• Read a zone's Ask settings
• The zone's dictionary
• Who would arrive if this unit's Autonomy Zone were enabled
• Read one zone with its layer stack and counts
• Agents assigned directly to this zone
• List the organization's org units
• List the organization's autonomy zones
• Assign an agent to a zone by hand
• Set a zone's Ask settings
• Make a zone the organization's default zone
• Rename and/or reparent a hand-made org unit

What happened: The platform's tenant isolation refused the request.

What to do: Contact support with the time of the request.