Package io.camunda.client.api.command

Interface CreateAgentInstanceCommandStep1

All Known Subinterfaces:

CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

All Known Implementing Classes:

CreateAgentInstanceCommandImpl

public interface CreateAgentInstanceCommandStep1

Represents a request to create a new agent instance.

Usage example:

   CreateAgentInstanceResponse response = camundaClient
       .newCreateAgentInstanceCommand()
       .elementInstanceKey(2251799813685248L)
       .model("gpt-4o")
       .provider("openai")
       .systemPrompt("You are a helpful assistant.")
       .send()
       .join();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2
static interface	CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep3
static interface	CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep4
static interface	CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep5

Method Summary

Modifier and Type	Method	Description
CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2	elementInstanceKey(long elementInstanceKey)	Sets the element instance key of the AHSP or AI Agent Task element instance.

Method Details

elementInstanceKey

CreateAgentInstanceCommandStep1.CreateAgentInstanceCommandStep2 elementInstanceKey(long elementInstanceKey)

Sets the element instance key of the AHSP or AI Agent Task element instance.

Parameters:

elementInstanceKey - the key of the element instance. Must be greater than 0.

Returns:

this builder for method chaining