Skip to main content
Version: latest (master)

Interface: AssemblyConfig

Defined in: src/types/assembly-config.ts:6

Properties

agentId?

optional agentId?: string

Defined in: src/types/assembly-config.ts:28


apiKey?

optional apiKey?: string

Defined in: src/types/assembly-config.ts:27

API key. When omitted, initAssembly resolves it via AAASM_API_KEY, the config file, or defaults to an empty string (local mode is unauth-accepting).


controlPlaneUrl?

optional controlPlaneUrl?: string

Defined in: src/types/assembly-config.ts:21

Control-plane HTTP base URL. When set, the gateway client routes its HTTP traffic here instead of gatewayUrl; when omitted it falls back to the resolved gatewayUrl (backwards-compatible). initAssembly also reads the AA_CONTROL_PLANE_URL environment variable as a fallback when this field is not set. The gRPC transport continues to use gatewayUrl.


delegationReason?

optional delegationReason?: string

Defined in: src/types/assembly-config.ts:46

Human-readable explanation for why this agent was delegated to. Must be ≤ 256 characters; throws RangeError otherwise.


enforcementMode?

optional enforcementMode?: EnforcementMode

Defined in: src/types/assembly-config.ts:60

Per-agent governance posture override sent to the gateway at registration.

When omitted, the field is left off the registration body and the gateway applies its server-side default (live "enforce") — the pre-feature wire shape is preserved. Pass "observe" to register this agent in dry-run / sandbox mode (every action proceeds; the gateway records would-be violations as shadow audit events surfaced by aa audit list --dry-run-only).

Unknown string values are rejected at runtime with a RangeError.


gatewayClient?

optional gatewayClient?: GatewayClient

Defined in: src/types/assembly-config.ts:36


gatewayUrl?

optional gatewayUrl?: string

Defined in: src/types/assembly-config.ts:13

Gateway URL. When omitted, initAssembly resolves it via AAASM_GATEWAY_URL, ~/.aasm/config.yaml, or the local default (http://localhost:7391, auto-started if absent). See agent_assembly/core/gateway-resolver for the precedence chain.


langchain?

optional langchain?: LangChainAdapterConfig

Defined in: src/types/assembly-config.ts:37


mode?

optional mode?: AssemblyMode

Defined in: src/types/assembly-config.ts:35


name?

optional name?: string

Defined in: src/types/assembly-config.ts:34

Human-readable agent name recorded by the gateway at registration (AAASM-3400). Descriptive metadata only; when omitted it falls back to agentId.


parentAgentId?

optional parentAgentId?: string

Defined in: src/types/assembly-config.ts:39

ID of the parent agent that delegated work to this agent.


spawnedByTool?

optional spawnedByTool?: string

Defined in: src/types/assembly-config.ts:48

Name of the tool that spawned this agent, if applicable.


teamId?

optional teamId?: string

Defined in: src/types/assembly-config.ts:41

Team this agent belongs to for budget and policy scoping.