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

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/agents
  • Auth: API key in header Authorization

Headers

Novu-Analytics-Sourcestring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.