Agent

​

Agent Class

The Agent class is the central component of the xpander SDK, representing an AI agent with capabilities for task execution, tool usage, and state management.

​

Retrieving an Agent

# Get an agent by ID
agent = client.agents.get(agent_id="agent-id-123")

Returns: Agent instance

​

Agent Properties

​

Core Properties

​

Configuration Properties

​

Agent Core Methods

​

update() / update()

Updates agent properties on the server.

# Update agent instructions
agent.instructions.general = "You are a helpful research assistant."
agent.instructions.goal = "Find accurate information."
agent.instructions.role = "Research, summarize, explain."

# Apply changes
agent.update()

Returns: Updated Agent object

​

sync() / sync()

Synchronizes changes to the agent (operations, graph connections, etc.)

# Synchronize agent
agent.sync()

Returns: Updated Agent object

​

disable_agent_end_tool() / disableAgentEndTool()

Disables the automatic task completion tool, giving more control over when a task ends.

# Disable automatic task completion
agent.disable_agent_end_tool()

Returns: void

​

update_user_details() / updateUserDetails()

Updates user details associated with the agent.

# Update user details
agent.update_user_details({
    "user_id": "user123",
    "name": "John Doe",
    "email": "john@example.com"
})

Returns: void

​

retrieve_node_from_graph() / retrieveNodeFromGraph()

Retrieves a node from the agent’s graph by its ID.

# Get a node from the graph
node = agent.retrieve_node_from_graph("tool-id-123")

Returns: GraphItem object or undefined if not found

​

Type Definitions

​

Instructions

interface Instructions {
  general: string;   // General instructions
  goal: string;      // Goal instructions
  role: string;      // Role instructions
}

​

Metadata

interface Metadata {
  description?: string;  // Agent description
  created_at: string;    // Creation timestamp
  updated_at: string;    // Last update timestamp
  llm_model?: string;    // Associated LLM model
}

​

UserDetails

interface UserDetails {
  userId: string;    // User ID
  name?: string;     // User name
  email?: string;    // User email
  role?: string;     // User role
}

​

Usage Example

from xpander_sdk import XpanderClient
import os

# Initialize client
client = XpanderClient(api_key=os.environ["XPANDER_API_KEY"])

# Get an agent
agent = client.agents.get(agent_id="agent-123")

# Update instructions
agent.instructions.general = "You are a research assistant."
agent.update()

​

Related Documentation