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

    Type Alias AgentInstanceCreationRequest

    Request to create a new agent instance.

    type AgentInstanceCreationRequest = {
        elementInstanceKey: ElementInstanceKey;
        history: AgentInstanceHistoryItem[];
        jobKey: JobKey;
        jobLease: JobLeaseToken;
    }
    Index
    elementInstanceKey: ElementInstanceKey

    The key of the AI Agent Sub-process or AI Agent Task element instance. The engine uses this key to infer processInstanceKey, elementId, processDefinitionKey, and tenantId.

    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. Must include a CONFIGURATION item establishing model, provider, and systemPrompt (and, if needed, limits). Every item's role must be CONFIGURATION or USER, and no item may carry non-zero usage-token metrics (inputTokens, outputTokens, reasoningTokenCount, cacheCreationTokenCount, cacheReadTokenCount); durationMs is exempt and may be non-zero.

    jobKey: JobKey

    The key of the job activation during which this creation is being made. A creation 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.