Member Junction
    Preparing search index...

    Type Alias ChatMessageContentBlock

    Defines the shape of a content block in a chat message. This can be used to represent different types of content in a message.

    type ChatMessageContentBlock = {
        content: string;
        fileName?: string;
        fileSize?: number;
        height?: number;
        isError?: boolean;
        mimeType?: string;
        toolCallId?: string;
        toolName?: string;
        type:
            | "text"
            | "image_url"
            | "video_url"
            | "audio_url"
            | "file_url"
            | "tool_result";
        width?: number;
    }
    Index

    Properties

    content fileName? fileSize? height? isError? mimeType? toolCallId? toolName? type width?

    Properties

    content

    content: string

    The content of the block. This can be a string. In the case of 'image_url', 'video_url', 'audio_url', or 'file_url', it should be a URL to the resource, OR it can be a base64 encoded string. representing the content of the item. For base64 images, use the data URL format: data:image/png;base64, For 'tool_result', this is the result payload the model should see — stringify non-text results.

    fileName?: string

    Optional original filename if the content was uploaded from a file.

    fileSize?: number

    Optional file size in bytes.

    height?: number

    Optional height in pixels (for images and videos).

    isError?: boolean

    For 'tool_result' blocks: whether the result represents a FAILED tool execution. Providers that model this natively (Anthropic's is_error) get it mapped through; others receive the error text as an ordinary result.

    mimeType?: string

    Optional MIME type for media content (e.g., 'image/png', 'image/jpeg', 'audio/mp3'). When content is a data URL, this can be extracted from the URL. When content is raw base64, this field is required.

    toolCallId?: string

    For 'tool_result' blocks: the ChatToolCall.id this block answers. Required on 'tool_result'; providers use it to pair a result with the call that requested it.

    toolName?: string

    For 'tool_result' blocks: the name of the tool that was called. Optional — carried for providers (and logs) that key results by name rather than id.

    type:
        | "text"
        | "image_url"
        | "video_url"
        | "audio_url"
        | "file_url"
        | "tool_result"

    The type of content block. Can be 'text', 'image_url', 'video_url', 'audio_url', 'file_url', or 'tool_result'.

    width?: number

    Optional width in pixels (for images and videos).

    Settings

    Member Visibility

    On This Page

    Properties