Package io.camunda.client.api.search.response

Interface AgentInstance

All Known Implementing Classes:
AgentInstanceImpl
public interface AgentInstance
Represents an agent instance returned from the Camunda REST API.

  • Method Details

    • getAgentInstanceKey

      long getAgentInstanceKey()
      Returns the unique key identifying this agent instance.

    • getStatus

      AgentInstanceStatus getStatus()
      Returns the current execution status of the agent instance.

    • getDefinition

      AgentInstance.Definition getDefinition()
      Returns the static definition of the agent, containing model, provider, and system prompt set at creation time.

    • getMetrics

      AgentInstance.Metrics getMetrics()
      Returns the aggregated runtime metrics for this agent instance.

    • getLimits

      AgentInstance.Limits getLimits()
      Returns the configured execution limits for this agent instance, set once at creation time.

    • getTools

      List<AgentInstance.Tool> getTools()
      Returns the list of tools available to this agent.

    • getElementId

      String getElementId()
      Returns the BPMN element ID of the ad-hoc sub-process or AI agent task.

    • getProcessInstanceKey

      long getProcessInstanceKey()
      Returns the key of the process instance that owns this agent instance.

    • getRootProcessInstanceKey

      long getRootProcessInstanceKey()
      Returns the key of the root process instance.

    • getProcessDefinitionKey

      long getProcessDefinitionKey()
      Returns the key of the process definition associated with this agent instance.

    • getProcessDefinitionId

      String getProcessDefinitionId()
      Returns the BPMN process ID of the associated process definition.

    • getProcessDefinitionVersion

      int getProcessDefinitionVersion()
      Returns the version number of the associated process definition.

    • getProcessDefinitionVersionTag

      String getProcessDefinitionVersionTag()
      Returns the version tag of the associated process definition, or null if none was configured.

    • getTenantId

      String getTenantId()
      Returns the tenant ID of this agent instance.

    • getCreationDate

      OffsetDateTime getCreationDate()
      Returns the timestamp when this agent instance was created.

    • getLastUpdatedDate

      OffsetDateTime getLastUpdatedDate()
      Returns the timestamp of the most recent update to this agent instance.

    • getCompletionDate

      OffsetDateTime getCompletionDate()
      Returns the timestamp when this agent instance completed, or null if still running.

    • getElementInstanceKeys

      List<Long> getElementInstanceKeys()
      Returns the keys of all element instances associated with this agent instance.