Skip to main content
GET
/
test_framework
/
v2
/
aiagents
/
List AI voice agents
curl --request GET \
  --url https://api.cekura.ai/test_framework/v2/aiagents/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
{
  "count": 123,
  "results": [
    {
      "description": "<string>",
      "id": 123,
      "name": "<string>",
      "project": 123,
      "language": "en",
      "telephony": {
        "phone_number": "<string>",
        "inbound": false,
        "sip_uri": "<string>",
        "sip_auth": "<unknown>",
        "websocket_url": "<string>",
        "websocket_auth": "<unknown>",
        "outbound_numbers": [
          "<string>"
        ]
      },
      "provider": {
        "agent_id": "<string>",
        "credentials": {
          "config": {
            "public_key": "<string>",
            "trigger_url": "<string>"
          }
        },
        "chat_agent_details": {
          "config": {
            "agent_id": "<string>"
          }
        },
        "auto_dial_outbound": true,
        "auto_import_calls": true,
        "auto_sync_prompt": true,
        "send_post_conversation_metadata": true
      },
      "agent_speaks_first": true,
      "knowledge_base_files": [
        {
          "agent": 123,
          "id": 123,
          "file_url": "<string>",
          "file_name": "<string>",
          "file_type": "<string>",
          "file_size": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "enabled_personalities": [
        123
      ],
      "webhook_url": "<string>",
      "webhook_secret_configured": "<string>",
      "mock_tools": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>",
          "mock_data": "<unknown>",
          "served_via": {
            "url": "<string>",
            "mock_index": 123
          }
        }
      ],
      "mock_tools_enabled": true,
      "mock_tools_provider": "<string>",
      "dynamic_variables": [
        {
          "id": 123,
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "https://api.cekura.ai/example/v1/example-external/?page=4",
  "previous": "https://api.cekura.ai/example/v1/example-external/?page=3"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
project_id
integer

Filter by project ID

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"https://api.cekura.ai/example/v1/example-external/?page=4"

​
previous
string<uri> | null
Example:

"https://api.cekura.ai/example/v1/example-external/?page=3"