Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Neuron scope

Every neuron has a scope field: core, workspace, or brain. Scope is the canonical way to describe how broadly a neuron is shared and which admin rules apply.
ScopeMeaning
brainDefault. Neuron belongs to a single brain; listed and edited in normal brain-scoped flows.
workspaceWorkspace-wide visibility. Changing to workspace requires workspace admin on the tenant.
coreCurated “core system” neurons (e.g. templates, platform defaults). Creating or promoting to core requires core admin validation on the API.
Receptors that target a neuron use the same scope on the receptor row: when you update a neuron’s scope, the API syncs the matching receptor’s scope so gateways stay aligned.

​
Completion type and trace persistence

Neurons with neuron_type: completion (see Neurons API) are optimized for structured, single-shot outputs. When executed outside a pathway graph, the worker persists durable engrams as trace_type: "system" so they do not appear in default thread / Trace Chat listings—you typically omit neuron_task_options for that behavior. For standard or agentic neurons invoked from cron, tools, or other background jobs, pass neuron_task_options: { trace_type: "system" } on POST /v1/neurons/:id/invoke or receptor invoke when you want the same hygiene. pathwayContext on the job still wins for pathway-scoped runs.

​
API usage

  • Create: optional scope (brain if omitted).
  • Update: send scope when changing tier; core admin rules apply when moving to or from core.
See Neurons API and Receptors API for endpoints.