List Agents

Returns a list of your agents and their metadata.

GET /v1/convai/agents

List Agents

cURL

curl --request GET \
  --url https://api.threetone.in/v1/convai/agents \
  --header 'x-api-key: <api-key>'

200

{
  "agents": [
    {
      "agent_id": "<string>",
      "name": "<string>",
      "created_at_unix_secs": 123,
      "access_info": {
        "is_creator": true,
        "creator_name": "<string>",
        "creator_email": "<string>"
      },
      "tags": [
        "<string>"
      ],
      "last_call_time_unix_secs": 123,
      "archived": false
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

APIKeyHeaderHTTPBearer

x-api-key · string · header · required

API key for programmatic access

Query Parameters

page_size · integer · default: 30

How many Agents to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 <= x <= 100

search · string | null

Search by agents name.

archived · boolean | null · default: false

Filter agents by archived status

sort_direction · enum<string> · default: desc

The direction to sort the results

Available options: asc, desc

sort_by · enum<string> | null

The field to sort the results by

Available options: name, created_at

cursor · string | null

Used for fetching next page. Cursor is returned in the response.

Response

200

application/json

Successful Response

agents · AgentSummaryResponseModel · object[] · required

A list of agents and their metadata

Show child attributes

has_more · boolean · required

Whether there are more agents to paginate through

next_cursor · string | null

The next cursor to paginate through the agents