Documentation / @agentick/core / RunInput

Interface: RunInput<P>

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

Input for run() and app.run().

Extends SendInput with configuration for the implicit layers (app creation, session creation) that run() and app.run() handle.

Progressive disclosure: run() needs model, app.run() doesn't (already configured).

Examples

typescript

const result = await run(<MyAgent />, {
  model,
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
  history: previousConversation.entries,
  maxTicks: 5,
});

typescript

const result = await app.run({
  props: { system: "You are helpful" },
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
  history: previousConversation.entries,
});

Extends

SendInput<P>

Type Parameters

P

P = { }

Properties

devTools?

optional devTools: boolean

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

Enable DevTools event emission

ephemeral?

optional ephemeral: EphemeralInput[]

Defined in: shared/src/protocol.ts:153

Ephemeral content (appended to compiled ephemeral)

Inherited from

SendInput.ephemeral

grounding?

optional grounding: GroundingInput[]

Defined in: shared/src/protocol.ts:149

Grounding context (ephemeral with _grounding metadata)

Inherited from

SendInput.grounding

history?

optional history: TimelineEntry[]

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

Previous conversation history to hydrate.

These become the initial timeline entries, available via useConversationHistory() and rendered by <Timeline />.

maxTicks?

optional maxTicks: number

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

Override maxTicks for this execution

Inherited from

SendInput.maxTicks

messages?

optional messages: Message[]

Defined in: shared/src/protocol.ts:141

Messages to deliver

Inherited from

SendInput.messages

metadata?

optional metadata: Record<string, unknown>

Defined in: shared/src/protocol.ts:145

Metadata attached to messages

Inherited from

SendInput.metadata

model?

optional model: EngineModel<ModelInput, ModelOutput>

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

Model instance (required for run(), optional for app.run())

props?

optional props: P

Defined in: shared/src/protocol.ts:143

Component props to update

Inherited from

SendInput.props

recording?

optional recording: RecordingMode

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

Recording mode for time-travel debugging

sections?

optional sections: SectionInput[]

Defined in: shared/src/protocol.ts:151

Named sections (JSX wins on ID collision)

Inherited from

SendInput.sections

signal?

optional signal: AbortSignal

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

Per-execution abort signal (not serializable — local only)

Inherited from

SendInput.signal

system?

optional system: string[]

Defined in: shared/src/protocol.ts:147

Additional system instructions (appended to compiled systemEntries)

Inherited from

SendInput.system

tools?

optional tools: ExecutableTool<(input, ctx?) => ContentBlock[] | Promise<ContentBlock[]>>[]

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

Additional tools for this execution. Merged with session and app tools (execution tools take priority on name conflict).

Inherited from

SendInput.tools