Skip to content

Documentation / @agentick/shared / CustomContentBlock

Interface: CustomContentBlock ​

Defined in: blocks.ts:352

Custom content block - Application-defined block extracted from model text output by StreamTagParser.

The tag field identifies the block type (e.g., "interpretation", "debug-info", "done"). The framework is tag-agnostic — applications give meaning to specific tag values.

Custom blocks preserve their temporal position in the content array, interleaved with text, tool_use, and other blocks exactly as the model emitted them.

Extends ​

Properties ​

attrs ​

readonly attrs: Record<string, string>

Defined in: blocks.ts:356


content ​

readonly content: string

Defined in: blocks.ts:355


createdAt? ​

readonly optional createdAt: string

Defined in: blocks.ts:58

ISO 8601 timestamp when this block was created

Inherited from ​

BaseContentBlock.createdAt


id? ​

readonly optional id: string

Defined in: blocks.ts:54

Unique identifier for this block

Inherited from ​

BaseContentBlock.id


index? ​

readonly optional index: number

Defined in: blocks.ts:62

Position of this block within the message

Inherited from ​

BaseContentBlock.index


messageId? ​

readonly optional messageId: string

Defined in: blocks.ts:56

ID of the message containing this block

Inherited from ​

BaseContentBlock.messageId


metadata? ​

readonly optional metadata: Record<string, any>

Defined in: blocks.ts:64

Additional metadata

Inherited from ​

BaseContentBlock.metadata


mimeType? ​

readonly optional mimeType: string

Defined in: blocks.ts:60

MIME type of the content (for media blocks)

Inherited from ​

BaseContentBlock.mimeType


selfClosing? ​

readonly optional selfClosing: boolean

Defined in: blocks.ts:357


summary? ​

readonly optional summary: string

Defined in: blocks.ts:66

Human-readable summary of the content

Inherited from ​

BaseContentBlock.summary


tag ​

readonly tag: string

Defined in: blocks.ts:354


type ​

readonly type: "custom" | CUSTOM

Defined in: blocks.ts:353

Discriminator for type narrowing (e.g., 'text', 'image', 'tool_use')

Overrides ​

BaseContentBlock.type

Released under the ISC License.