GET /v1/agents

List agents

Returns a list of agents in your account.

Returns a paginated list of all agents in your account. The agents are returned sorted by creation date, with the most recently created agents appearing first.

Query Parameters

limit

integer

Number of agents to return. Default is 20, maximum is 100.

offset

integer

Offset for pagination. Use with limit to paginate through results.

status

string

Filter agents by status. One of: active, paused, archived.

Response

Returns an object with a data property containing an array of agent objects, along with pagination metadata.

data

array

An array of agent objects.

has_more

boolean

Whether there are more results available.

total

integer

Total number of agents matching the query.

The Agent Object

id

string

Unique identifier for the agent, prefixed with agt_.

name

string

The name of the agent.

status

string

Current status: active, paused, or archived.

model

string

The AI model powering this agent.

created_at

timestamp

ISO 8601 timestamp of when the agent was created.

Request

curl https://api.celeriscloud.io/v1/agents \
  -H "Authorization: Bearer cel_live_xxxx"import celeris

client = celeris.Client("cel_live_xxxx")
agents = client.agents.list(
    limit=10,
    status="active"
)import Celeris from 'celeris';

const celeris = new Celeris('cel_live_xxxx');
const agents = await celeris.agents.list({
  limit: 10,
  status: 'active'
});import "github.com/celeris/celeris-go"

client := celeris.NewClient("cel_live_xxxx")
agents, err := client.Agents.List(&celeris.ListParams{
    Limit:  10,
    Status: "active",
})

Response 200 OK

{
  "object": "list",
  "data": [
    {
      "id": "agt_1234567890abcdef",
      "object": "agent",
      "name": "Customer Support Bot",
      "status": "active",
      "model": "gpt-4",
      "description": "Handles customer inquiries",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "has_more": true,
  "total": 42
}