Skip to main content
PATCH
cURL
Enabling (enforced: true) requires Enterprise and the Incognito agents role permission (organization:enforce_agent_incognito), separate from the Incognito tasks permission. Disabling requires only update access, including after a downgrade.Existing sessions keep their original mode. Incognito does not save message content for history or search, but task metadata and temporary message caches can remain.Returns the full updated agent, including agent.incognito.enforced. Generic PATCH /agents/{agent_id} rejects top-level incognito with 400 invalid_request.

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Path Parameters

agent_id
string
required

ID of a custom agent. Platform agents are not customizable.

Body

application/json
enforced
boolean
required

Enable or disable incognito enforcement for new tasks.

Example:

true

Response

The full updated agent. The example focuses on incognito fields; other agent fields are omitted for readability.

agent
object
required

An agent and its whole configuration. Single-agent retrieve, create and update return this shape; the list endpoint does not populate the inlined collections, abilities or version. Collection-specific writes return their own result shapes.