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

    Type Alias AgentInstanceHistoryItemRequest

    Request to append a single history item to an agent instance's conversation history.

    type AgentInstanceHistoryItemRequest = {
        content: AgentInstanceMessageContent[];
        elementInstanceKey: ElementInstanceKey;
        jobKey: JobKey;
        jobLease: string;
        loopIteration?: LoopIterationId | null;
        metrics?: AgentInstanceHistoryItemMetrics | null;
        producedAt: string;
        role: AgentInstanceHistoryRoleEnum;
        toolCalls?: AgentInstanceToolCall[] | null;
    }
    Index
    content elementInstanceKey jobKey jobLease loopIteration? metrics? producedAt role toolCalls?

    content

    content: AgentInstanceMessageContent[]

    The content blocks of this history item.

    elementInstanceKey: ElementInstanceKey

    The key of the currently-active element instance.

    jobKey: JobKey

    The key of the current job activation during which this history item was produced.

    jobLease: string

    Opaque lease token received from the job activation response.

    loopIteration?: LoopIterationId | null

    The loopIteration this item belongs to. A loopIteration is one pass through the agent feedback loop: one LLM call, its tool dispatches, and their results. Omit if not grouping items by loopIteration.

    metrics?: AgentInstanceHistoryItemMetrics | null

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

    producedAt: string

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

    role: AgentInstanceHistoryRoleEnum

    The role of this history item in the conversation.

    toolCalls?: AgentInstanceToolCall[] | null

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

    Settings
    Member Visibility

    On This Page
    Properties