Skip to main content
GET
/
api
/
v1
/
agents
List Agents
curl --request GET \
  --url https://api.agentwallex.com/api/v1/agents \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "agent_name": "<string>",
      "agent_description": "<string>",
      "wallet": {
        "address": "<string>",
        "chain": "<string>"
      },
      "status": "active",
      "metadata": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "has_more": true
}
Retrieve a paginated list of agents associated with your account. Supports filtering by status and chain.

Query Parameters

page_num
integer
default:"1"
Page number (1-indexed).
page_size
integer
default:"20"
Number of items per page. Maximum: 100.
status
string
Filter by agent status. Values: active, inactive.
chain
string
Filter by CAIP-2 chain identifier (e.g., eip155:84532).

Response

Example

curl -X GET "https://api.agentwallex.com/api/v1/agents?page_num=1&page_size=20&status=active&chain=eip155:84532" \
  -H "X-API-Key: awx_your_api_key"
Response
{
  "data": [
    {
      "id": "agent_abc123",
      "agent_name": "research-bot",
      "wallet": {
        "address": "0x1234...5678",
        "chain": "eip155:84532"
      },
      "status": "active",
      "created_at": "2025-06-01T10:00:00Z"
    }
  ],
  "total": 3,
  "has_more": false
}

Authorizations

X-API-Key
string
header
required

API key authentication. Keys are prefixed with awx_.

Query Parameters

page_num
integer
default:1

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:20

Number of items per page.

Required range: 1 <= x <= 100
status
enum<string>

Filter by agent status.

Available options:
active,
inactive
chain
string

Filter by CAIP-2 chain identifier (e.g., eip155:84532).

Response

Paginated list of agents.

Standard paginated response wrapper.

data
object[]

Array of resource objects.

total
integer

Total number of items matching the query.

has_more
boolean

Whether more pages are available.