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

    Type Alias AgentInstanceUpdateRequest

    Request to update the mutable state of an agent instance.

    type AgentInstanceUpdateRequest = {
        elementInstanceKey: ElementInstanceKey;
        history?: AgentInstanceHistoryItem[] | null;
        jobKey: JobKey;
        jobLease: JobLeaseToken;
        status?: AgentInstanceUpdateStatusEnum;
    }
    Index
    elementInstanceKey: ElementInstanceKey

    The key of the currently-active element instance for this agent instance. Used for ownership/equality validation against the stored agent instance and, when the supplied key differs from the previous association (re-entry of an ad-hoc sub-process or AI Agent task), appended to elementInstanceKeys with the reverse link updated on the supplied element instance. Only one element instance may hold this write claim at a time: any update from a different element instance is rejected while the current writer's job is still active.

    history?: AgentInstanceHistoryItem[] | null

    A batch of history items to append to the agent instance's conversation history, in request order. Each created item is echoed back in the response's createdHistory, positionally correlated.

    jobKey: JobKey

    The key of the job activation during which this update is being made. An update must always be attributed to the active job that produced it.

    jobLease: JobLeaseToken

    Opaque lease token received from the job activation response. Disambiguates this activation from any other activation of the same job: if the job is later retried, history items submitted under a superseded lease are discarded rather than committed.

    The new status of the agent instance.