Trillet AI logo

Get Call Agent

Retrieve the details of a single call agent based on its unique identifier.

GEThttps://api.trillet.ai/v1/api/agents/{agentId}

Headers

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

agentIdstringrequired

The unique identifier of the agent.

{
  "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"
}

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.

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.

Errors

StatusBodyWhen
400{"error": "Workspace ID is required"}No x-workspace-id
404{"error": "Agent not found"}No agent with this ID in the workspace
500{"error": "..."}Unexpected server error

Last updated on