For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: AgentInstanceCreationRequest

type AgentInstanceCreationRequest = object;

Request to create a new agent instance.

Properties​

elementInstanceKey​

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.

history​

history: AgentInstanceHistoryItem[];

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: 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.

jobLeaseToken​

jobLeaseToken: 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.