Documentation / @agentick/shared / SessionContextPayload

Interface: SessionContextPayload

Defined in: protocol.ts:222

Payload for session:context channel.

Broadcast after each tick with context utilization info. Enables real-time context tracking in UI.

Properties

cacheCreationTokens?

optional cacheCreationTokens: number

Defined in: protocol.ts:242

Tokens written to KV cache this tick (provider-dependent)

---

cachedInputTokens?

optional cachedInputTokens: number

Defined in: protocol.ts:240

Input tokens served from KV cache (provider-dependent)

---

cacheHitRatio?

optional cacheHitRatio: number

Defined in: protocol.ts:244

Ratio of cached to total input tokens (0-1)

---

contextWindow?

optional contextWindow: number

Defined in: protocol.ts:230

Context window size in tokens

---

cumulativeUsage?

optional cumulativeUsage: object

Defined in: protocol.ts:256

Cumulative usage across all ticks in this execution

inputTokens

inputTokens: number

outputTokens

outputTokens: number

ticks

ticks: number

totalTokens

totalTokens: number

---

inputTokens

inputTokens: number

Defined in: protocol.ts:232

Input tokens used (what was sent to model)

---

isReasoningModel?

optional isReasoningModel: boolean

Defined in: protocol.ts:252

Whether this is a reasoning model

---

maxOutputTokens?

optional maxOutputTokens: number

Defined in: protocol.ts:246

Max output tokens the model supports

---

modelId

modelId: string

Defined in: protocol.ts:224

Model ID (e.g., "gpt-4o", "claude-3-5-sonnet-20241022")

---

modelName?

optional modelName: string

Defined in: protocol.ts:226

Human-readable model name

---

outputTokens

outputTokens: number

Defined in: protocol.ts:234

Output tokens generated

---

provider?

optional provider: string

Defined in: protocol.ts:228

Provider name (e.g., "openai", "anthropic")

---

supportsToolUse?

optional supportsToolUse: boolean

Defined in: protocol.ts:250

Whether the model supports tool use

---

supportsVision?

optional supportsVision: boolean

Defined in: protocol.ts:248

Whether the model supports vision

---

tick

tick: number

Defined in: protocol.ts:254

Current tick number

---

timestamp

timestamp: string

Defined in: protocol.ts:263

ISO timestamp

---

totalTokens

totalTokens: number

Defined in: protocol.ts:236

Total tokens (input + output)

---

utilization?

optional utilization: number

Defined in: protocol.ts:238

Context utilization as percentage (0-100)