API Reference · AI employees

List AI employees

Returns every AI employee in your company, newest first, with its script, voice settings and call stats. Use it to look up the agent_id that campaigns and phone numbers need.

GET/agents

https://calling.ubiqproject.com/api/v1/agents · Auth: API key (full or read-only)

Request

No parameters. There is no pagination — every AI employee is returned.

Request

curl https://calling.ubiqproject.com/api/v1/agents \
  -H "Authorization: Bearer vk_live_YOUR_KEY"

Response

An array of AI employees.

Response · 200

[
  {
    "id": "3f8c2a1e-6b4d-4c7a-9e21-5d0f7b8a9c34",
    "slug": "priya",
    "name": "Priya",
    "greeting": "Namaste! This is Priya from Sharma Finance. Am I speaking with {{name}}?",
    "system_prompt": "You remind customers about upcoming EMI payments…",
    "tools_enabled": [],
    "knowledge_base_ids": ["0c7d2e91-4a6b-4f38-9d15-b2e8a7c3f640"],
    "flow_sections": [
      { "id": "goal", "title": "Goal", "body": "Confirm the payment date.", "enabled": true }
    ],
    "voice_config": {
      "model": "ultravox",
      "voice_id": "default",
      "speed": 1.0,
      "temperature": 0.7
    },
    "user_starts_first": false,
    "silence_handling": null,
    "end_call_rules": null,
    "transfer_config": null,
    "widget_config": null,
    "prefetch_webhook_url": null,
    "end_of_call_webhook_url": null,
    "is_active": true,
    "created_at": "2026-09-21T06:42:10.118204Z",
    "stats": { "total_calls": 412, "avg_duration_sec": 74 }
  }
]

Response fields

idstring (UUID)

The AI employee's ID — the agent_id other endpoints take.

slugstring

A URL-friendly version of the name.

namestring

The name callers hear. Unique within your company.

greetingstring

The first thing it says. {{placeholders}} are filled from contact columns.

system_promptstring

The script and instructions it follows.

tools_enabledstring[]

Actions it may take during a call.

knowledge_base_idsstring[]

IDs of the knowledge documents it answers from.

flow_sectionsobject[]

Script sections: id, title, body, enabled.

voice_configobject

Always has model, voice_id, speed and temperature. It may carry more model-specific settings; treat unknown keys as opaque.

user_starts_firstboolean

Waits for the caller to speak first instead of greeting.

silence_handling, end_call_rules, transfer_config, widget_configobject | null

Call-behaviour settings from the dashboard. null when never set.

prefetch_webhook_urlstring | null

Called before each call to fetch caller details.

end_of_call_webhook_urlstring | null

Receives the result after each call.

is_activeboolean

true when live. New AI employees start as drafts (false) until someone puts them live.

created_atstring (ISO 8601)

When it was created.

statsobject

total_calls and avg_duration_sec, across all its calls.

Read-only over the API

Creating, editing and deleting AI employees, and linking knowledge documents, are done in the dashboard. Those actions don't accept an API key.