Skip to main content
GET
/
v1
/
agents
List agents
curl --request GET \
  --url https://api.coval.dev/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "agents": [
    {
      "id": "abc123def456ghi789jklm",
      "display_name": "Customer Support Agent",
      "model_type": "MODEL_TYPE_VOICE",
      "phone_number": "+1234567890",
      "endpoint": "https://api.example.com/agent",
      "prompt": "You are a helpful customer support agent...",
      "metadata": {
        "voice": "alloy",
        "model": "gpt-4o-realtime-preview"
      },
      "workflows": {},
      "metric_ids": [
        "abc123def456ghi789jklm"
      ],
      "test_set_ids": [
        "gT5wq2Hn"
      ],
      "knowledge_base_ids": [],
      "create_time": "2025-10-14T12:00:00Z",
      "update_time": "2025-10-15T14:30:00Z"
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOjUwfQ=="
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
filter
string

Filter expression syntax.

Supported fields: model_type, display_name, create_time, update_time

Operators: =, !=, >, <, >=, <=, AND, OR

Values may be unquoted or double-quoted. Values containing spaces must be quoted (e.g., display_name="Support Agent").

Date format: ISO 8601 (e.g., 2025-10-01T00:00:00Z)

​
page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 100
​
page_token
string

Opaque pagination token from previous response.

Do not decode or modify this token.

​
order_by
string
default:-create_time

Sort order specification.

Formats:

  1. Dash-prefix: -create_time (descending), display_name (ascending)
  2. Space-separated: create_time desc, display_name asc

Sortable fields: create_time, update_time, display_name, model_type

​
tag_filters
string[]

Filter agents by tags. A resource matches when it has ALL the listed tags (AND-semantics).

Repeat the parameter for each tag (e.g., ?tag_filters=production&tag_filters=voice).

Maximum array length: 20

Response

Agents retrieved successfully

​
agents
object[]
required

List of agent resources

​
next_page_token
string | null

Token for fetching next page (null if no more results)

Example:

"eyJvZmZzZXQiOjUwfQ=="