Trillet AI logo

List Call Agents

Retrieve a list of all call agents with all their details.

GEThttps://api.trillet.ai/v1/api/agents

Returns a plain array of every agent in the workspace, newest first, including agents whose call flow is archived. There is no pagination. Each item also carries a summary of the call flow that uses it (flowName, pathway, flowIsLive and so on), so filter on flowIsLive to find agents that can take calls.

Headers

x-workspace-idstringrequired

Workspace identifier for the API.

[
  {
    "ttsModel": {
      "language": "en",
      "provider": "openai",
      "voiceId": "alloy",
      "name": "Alloy"
    },
    "_id": "example-agent-id-1",
    "workspaceId": "example-workspace-id-1",
    "userId": "example-user-id-1",
    "name": "Test-Agent-1",
    "llmModel": "gpt-4o-mini",
    "type": "voice",
    "settings": {
      "speed": 0,
      "volume": 1,
      "temperature": 0.3
    },
    "status": "ready",
    "activeSessions": [],
    "createdAt": "2025-01-19T02:57:27.923Z",
    "updatedAt": "2025-01-19T02:57:27.923Z"
  },
  {
    "ttsModel": {
      "language": "en",
      "provider": "cartesia",
      "voiceId": "example-voice-id-2",
      "name": "Sarah"
    },
    "_id": "example-agent-id-2",
    "workspaceId": "example-workspace-id-2",
    "userId": "example-user-id-2",
    "name": "New-Agent",
    "llmModel": "gpt-4o-mini",
    "type": "voice",
    "settings": {
      "speed": 0,
      "volume": 1,
      "temperature": 0.7
    },
    "status": "ready",
    "activeSessions": [
      {
        "roomName": "example-room-1",
        "startTime": "2025-01-16T14:46:36.883Z",
        "status": "active",
        "_id": "example-session-id-1"
      },
      {
        "roomName": "example-room-2",
        "startTime": "2025-01-16T21:10:47.518Z",
        "status": "active",
        "_id": "example-session-id-2"
      }
    ],
    "createdAt": "2024-12-27T10:49:04.175Z",
    "updatedAt": "2025-01-17T09:09:47.887Z"
  }
]

Response Fields

ttsModelobject

Contains the text-to-speech model details.

ttsModel.languagestring

The language of the voice model (e.g., en).

ttsModel.providerstring

The TTS provider name (e.g., openai, cartesia).

ttsModel.voiceIdstring

The unique identifier for the voice model.

ttsModel.namestring

The name of the voice model.

_idstring

Unique identifier for the agent.

workspaceIdstring

Unique identifier for the workspace associated with the agent.

userIdstring

Unique identifier for the user associated with the agent.

namestring

Name of the agent.

llmModelstring

The LLM (language model) used by the agent (e.g., gpt-4o-mini).

typestring

Type of agent (e.g., voice).

settingsobject

The settings for the agent, including speed, volume, and temperature.

settings.speednumber

Speaking speed. How it is applied depends on the voice provider; 0 means the provider's normal speed.

settings.volumenumber

Volume of the voice.

settings.temperaturenumber

Creativity of the language model, from 0 to 1.

statusstring

The current status of the agent (e.g., ready).

phoneNumberIdsarray

The agent's phone numbers as full phone number objects (not IDs).

fallbackTtsModelobject | null

Fallback voice, if one is set.

sttProviderobject | null

Speech-to-text provider (id, name, description), if one is set.

fallbackSttProviderobject | null

Fallback speech-to-text provider, if one is set.

fallbackLlmModelstring | null

Fallback language model, if one is set.

flowNamestring | null

Name of the call flow that uses this agent, or null if none does.

pathwaystring | null

ID of that call flow.

flowDirectionstring | null

Direction of that call flow: outbound or bidirectional.

flowIsLiveboolean

Whether a number given to this agent would take calls. false when the agent has no call flow, or its flow is archived or inactive.

flowArchivedAtstring | null

When the call flow was archived, or null.

hipaaComplianceboolean

Whether the agent's call flow has HIPAA mode on.

activeSessionsarray

A list of active sessions associated with the agent.

createdAtstring

The timestamp when the agent was created.

updatedAtstring

The timestamp when the agent was last updated.

Last updated on