Skip to main content

Nova Agent Builder

Nova Agent Builder lets a workspace user create their own custom Nova agent: a named, workspace-scoped assistant with its own instructions, capabilities, and knowledge scope.

The core principle: capabilities gate writes only​

  • Reads are always on. Every agent — system or custom — can always search objects, read types, run aggregations, read documentation and Docs pages, use the calculator, read date/time, look up user info, search the web, and read spaces. Not configurable.
  • Writes are opt-in. What you configure on a custom agent is which write actions it may perform — nothing more.
  • Admin/site/workflow writes are reserved for system agents and can never be enabled on a custom agent.

Building a custom agent is about narrowing behavior and scoping data (instructions + knowledge), and granting a small, safe set of write permissions (capabilities). It can always read.

Configuring a custom agent​

FieldRequiredDefaultMeaning
nameYes—Display name.
descriptionNo—Short human description.
instructionsNo—A free-text persona/behavior prompt, injected into the agent's system prompt at runtime.
visibilityNoPRIVATEPRIVATE — only the creator can see and use it. WORKSPACE — everyone in the workspace can use it.
conversationStartersNononeSuggested prompts shown to users.
Capabilities (subAgentTypes)NononeThe write permissions the agent may use — see below.
SurfacesNoCHATWhere the agent can run — see below.
Visibility default nuance

The create API defaults visibility to PRIVATE, even though the database column itself defaults to WORKSPACE — an agent created without explicitly setting visibility ends up PRIVATE. Always set it explicitly to avoid surprises.

Knowledge sources are configured separately, after creation.

Capabilities​

Ten capabilities can be enabled on a custom agent — all object, comment, or Docs writes; none require admin access.

CapabilityAllows
OBJECT_CREATECreate objects
OBJECT_UPDATEUpdate existing objects' attributes
OBJECT_TRANSITIONMove objects through workflow states
OBJECT_DELETEDelete objects
COMMENT_CREATEPost comments
COMMENT_UPDATEEdit comments
COMMENT_DELETEDelete comments
COMMENT_REACTIONAdd/remove emoji reactions on comments
DOCS_CREATECreate Docs pages
DOCS_UPDATEUpdate Docs pages

The live, authoritative list is available at GET /external/v1/nova-agent/capabilities. Enabling anything outside this list (an admin/site/workflow write) is rejected with Capability <X> cannot be enabled on a custom agent.

Always-on reads (not configurable): search, types, aggregations, documentation, Docs, the calculator, date/time, user info, web search, and spaces.

Knowledge sources​

Knowledge sources constrain what data the agent reasons over — every search and aggregation it performs stays inside the configured scope.

Source typeInputMeaning
TYPEa type IDScope to objects of one Starhive type. Rejected with Type <id> is not accessible in this workspace if the type isn't accessible to the caller.
STARQL_QUERYa StarQL queryScope to the results of that query.

Knowledge is additive — add as many sources as needed; each is managed and removable individually.

Surfaces​

SurfaceMeaning
CHATAvailable in interactive chat, with streamed responses.
AUTOMATIONCan be invoked headlessly by an automation trigger.

A custom agent must have at least one surface — an agent enabled only for CHAT can't be fired by automations, and vice versa.

Permissions and ownership​

ActionWho's allowed
View a system agentEveryone, in every workspace
View a WORKSPACE custom agentAnyone in the same workspace
View a PRIVATE custom agentOnly the creator
Edit, delete, or change capabilities/knowledgeOnly the creator — even for a WORKSPACE-visible agent
Edit a system agentNobody — rejected with System Nova agents cannot be modified

Deleting a custom agent is a soft delete: it's marked deleted and the deletion cascades to the agent's conversations, rather than hard-deleting anything.

Invoking a custom agent​

  • Chat — selected by ID in a conversation, runs through the streaming chat controller. Requires the CHAT surface.
  • Automation — an automation/event trigger invokes the agent with the triggering object IDs prepended to the prompt as context, running as the triggering user, fire-and-forget. Requires the AUTOMATION surface.

FAQ​

  • Why can't my agent read a certain object? A bound knowledge source scopes it — and reads are always further bounded by the invoking user's own permissions.
  • My agent can't write even though I enabled the capability. Check that the invoking user also has permission to perform that write — the agent acts as the user, not with elevated access.
  • Colleagues can't see my agent. Visibility defaults to PRIVATE — set it to WORKSPACE.
  • A colleague can use but not edit my workspace agent. By design — only the creator can edit.
  • My automation can't trigger the agent. Add the AUTOMATION surface.