Skip to content

Documentation / @agentick/core / SpawnOptions

Interface: SpawnOptions ​

Defined in: core/src/app/types.ts:710

Options for overriding inherited behavior in spawned child sessions.

By default, children inherit structural options (model, tools, runner, maxTicks) from the parent. SpawnOptions lets you override any of these.

Example ​

typescript
// Spawn with a different runner
await session.spawn(CodeAgent, { messages }, {
  runner: replRunner,
});

// Spawn with a different model
await session.spawn(SummaryAgent, { messages }, {
  model: cheapModel,
  maxTicks: 3,
});

Properties ​

label? ​

optional label: string

Defined in: core/src/app/types.ts:718

Display label for this spawn (shown in UI)


maxTicks? ​

optional maxTicks: number

Defined in: core/src/app/types.ts:716

Override the parent's max ticks


metadata? ​

optional metadata: Record<string, unknown>

Defined in: core/src/app/types.ts:720

Immutable identity labels for the child session


model? ​

optional model: EngineModel<ModelInput, ModelOutput>

Defined in: core/src/app/types.ts:712

Override the parent's model


runner? ​

optional runner: ExecutionRunner

Defined in: core/src/app/types.ts:714

Override the parent's execution runner

Released under the ISC License.