Skip to content

AIDK API Reference / aidk-shared / TimelineEntry

Interface: TimelineEntry ​

Defined in: packages/shared/src/timeline.ts:28

Timeline entry - represents a message or event in the conversation.

Tool calls and results are embedded in message content blocks:

  • Tool calls: tool_use blocks in assistant messages
  • Tool results: tool_result blocks in tool messages

This unified format is used by both client and backend. Backend extends this with SemanticContentBlock[] and renderer fields.

Extended by ​

Properties ​

PropertyTypeDescriptionDefined in
id?stringUnique identifier for this timeline entrypackages/shared/src/timeline.ts:32
kind"message" | "event"Kind of timeline entry - 'message': Regular conversation message (user, assistant, system, tool) - 'event': Application event (user actions, system events, state changes)packages/shared/src/timeline.ts:39
messageMessageThe message content. Tool calls and results are embedded in message.content as blocks: - Assistant messages may contain tool_use blocks - Tool messages contain tool_result blockspackages/shared/src/timeline.ts:47
metadata?Record<string, unknown>Optional metadatapackages/shared/src/timeline.ts:65
tags?string[]Tags for categorization and filteringpackages/shared/src/timeline.ts:60
visibility?"model" | "observer" | "log"Visibility control - who can see this entry - 'model': Visible to the model (default) - 'observer': Visible to observers/logs but not model - 'log': Only in logs, not visible to model or observerspackages/shared/src/timeline.ts:55

Released under the MIT License.