Agents API
Core Feature: Agents are autonomous financial entities with their own wallets, balances, and transaction rules.
Agent Model
Complete Control: Configure transaction limits, approval requirements, and other rules to precisely control how your agents handle funds.
- Identity: Unique ID, name, and description
- Financial Details: Associated wallet address and balance
- Payment Rules: Transaction limits and approval requirements
- Status: Current operational status (active, inactive, paused)
- Metadata: Tags, creation timestamp, and other attributes
Agent Structure
Available Endpoints
Get Agent
Fetch details of a specific agent
Create Agent
Create a new agent and fund its wallet
List User Agents
Fetch all agents for a user
Deposit to Agent
Deposit funds into an agent’s wallet
Withdraw from Agent
Withdraw funds from an agent’s wallet
Agent Lifecycle
The typical lifecycle of an agent includes:- Creation: An agent is created with a name, description, and initial funding
- Configuration: Payment rules are set to control transaction limits and approval requirements
- Active Operation: The agent processes transactions according to its configured rules
- Maintenance: Funds can be added or withdrawn as needed
- Status Changes: An agent’s status can be modified as needed
Payment Rules
Safety First: Configure rules to prevent unauthorized spending and ensure financial operations stay within your defined parameters.
- Daily Limit: Maximum amount the agent can spend in a 24-hour period
- Transaction Limit: Maximum amount for a single transaction
- Approval Requirements:
requireApprovalForAll: When true, all transactions require manual approvalrequireApprovalAboveAmount: Transactions above this amount require approval
Best Practices
- Create separate agents for different purposes or departments
- Use descriptive names and tags to easily identify agents
- Set appropriate transaction limits based on expected usage patterns
- Consider requiring approval for large transactions to prevent unauthorized spending
- Regularly monitor agent activity to ensure proper operation
Blockchain Integration: All agent wallets are real blockchain wallets, with transactions recorded on-chain for maximum transparency and security.