Sign in
Agents

Update an agent

Update an agent by its external identifier.

patch/v1/agents/{identifier}

Path parameters

identifierstring required

Request body

namestring
descriptionstring
activeboolean
bridgeUrlstring

Production bridge URL for this agent

devBridgeUrlstring

Development bridge URL (set by npx novu dev)

devBridgeActiveboolean

Whether the dev bridge override is active

Response

OK

_idstring required
namestring required
identifierstring required
descriptionstring
activeboolean required
bridgeUrlstring

Production bridge URL

devBridgeUrlstring

Development bridge URL (set by npx novu dev)

devBridgeActiveboolean

Whether the dev bridge override is active

runtime'self-hosted' | 'managed'

Whether the agent brain is self-hosted (bridge) or managed by a third-party provider

visibility'public' | 'private'

Discovery scope of the agent. Always public today; reserved for the upcoming private-agents feature.

_environmentIdstring required
_organizationIdstring required
createdBystring

Mongo user id of the user who created the agent

createdAtstring required
updatedAtstring required
exceedsPlanLimitboolean

Cloud only. true when the agent falls outside the organization plan agent limit (by creation order among active agents — inactive agents do not consume slots). Only plan limits produce this flag — system-capped organizations (enterprise/unlimited tiers) are never over-limit. Over-limit agents are still stored but will not respond to inbound messages until the plan is upgraded or older agents are deactivated.

Changes

Changed in 2 of the 13 revisions of this API.2