Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Agents

Create an agent

Create an agent scoped to the current environment. The identifier must be unique per environment. Set runtime to managed and supply managedRuntime to provision a provider-hosted agent brain.

post/v1/agents

Headers

Novu-Analytics-Sourcestring required
idempotency-keystring

A header for idempotency purposes

Request body

namestring required

Required when not adopting an existing managed agent (i.e. when managedRuntime.externalAgentId is absent). Optional in adopt mode where the name is resolved from the provider.

identifierstring required

Required when not adopting an existing managed agent. Auto-generated from the provider agent name when omitted in adopt mode.

descriptionstring
activeboolean
runtime'self-hosted' | 'managed'

Response

Created

_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.