@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias AgentInstanceHistoryItem

    A single history item to append to the agent instance's conversation history, submitted as part of the batch on an agent instance update request.

    type AgentInstanceHistoryItem = {
        content: AgentInstanceMessageContent[];
        historyItemId: string;
        limits?: AgentInstanceLimits;
        loopIteration: LoopIterationId;
        metrics?: AgentInstanceHistoryItemMetrics | null;
        model?: string;
        producedAt: string;
        provider?: string;
        role: AgentInstanceHistoryRoleEnum;
        systemPrompt?: AgentInstanceMessageContent[] | null;
        toolCalls?: AgentInstanceToolCall[] | null;
        tools?: AgentTool[] | null;
    }
    Index
    content historyItemId limits? loopIteration metrics? model? producedAt provider? role systemPrompt? toolCalls? tools?

    content

    content: AgentInstanceMessageContent[]

    The content blocks of this history item.

    historyItemId: string

    Caller-assigned identifier used to detect and dedupe retries of the same item. For example, when a retried job activation resubmits history items it already sent in an earlier attempt, those items are not rejected; they are flagged via isDuplicate in the response instead. Must be non-blank.

    limits?: AgentInstanceLimits

    The operational limits as of this entry. CONFIGURATION items only; omit for other roles.

    loopIteration: LoopIterationId

    The loop iteration this item belongs to.

    metrics?: AgentInstanceHistoryItemMetrics | null

    Per-call token and latency metrics. Present on ASSISTANT items only.

    model?: string

    The LLM model identifier as of this entry. CONFIGURATION items only; omit for other roles.

    producedAt: string

    The agent-side timestamp of when this message was produced.

    provider?: string

    The LLM provider as of this entry. CONFIGURATION items only; omit for other roles.

    role: AgentInstanceHistoryRoleEnum

    The role of this history item in the conversation.

    systemPrompt?: AgentInstanceMessageContent[] | null

    The system prompt, as content blocks, as of this entry. CONFIGURATION items only; omit for other roles. Omit to leave the system prompt unchanged; when present, must be non-empty.

    toolCalls?: AgentInstanceToolCall[] | null

    Tool calls associated with this history item. For ASSISTANT items: tool calls dispatched by this LLM response. For TOOL_RESULT items: single-entry array referencing the originating tool call. Omit for USER items.

    tools?: AgentTool[] | null

    The complete list of tools available to the agent as of this entry. CONFIGURATION items only; omit for other roles. Omit to leave the tool list unchanged; send an empty array to clear it.

    Settings
    Member Visibility

    On This Page
    Properties