Skip to main content

Agent

An agent is a conversational assistant scoped to an environment. Agents receive inbound messages from linked channel integrations and respond through a self-hosted bridge or a managed runtime provider. Read more in the agents overview.
FieldTypeDescription
_idstringUnique identifier of the agent record in the database.
namestringDisplay name shown in connected channels such as Slack and Microsoft Teams.
identifierstringExternal slug used in API paths and SDK calls. Unique per environment.
descriptionstringOptional summary of the agent’s purpose.
activebooleanWhether the agent accepts inbound messages.
runtimestringAgent brain mode: self-hosted (bridge) or managed (provider-hosted).
bridgeUrlstringProduction bridge URL registered for self-hosted agents.
devBridgeUrlstringDevelopment bridge URL set by npx novu dev.
devBridgeActivebooleanWhether the development bridge override is active.
behaviorobjectOptional delivery behavior such as acknowledgement and reaction settings.
managedRuntimeobjectPresent when runtime is managed. Contains provider identifiers, tools, MCP servers, and system prompt metadata.
integrationsarraySummary of channel integrations linked to the agent.
_environmentIdstringEnvironment the agent belongs to.
_organizationIdstringOrganization that owns the agent.
createdAtstringISO timestamp when the agent was created.
updatedAtstringISO timestamp when the agent was last updated.