Get Call Agent

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

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

agentIdstringrequired

The unique identifier of the agent.

{
  "ttsModel": {
    "language": "en",
    "provider": "openai",
    "voiceId": "example-voice-id-1",
    "name": "ExampleVoice"
  },
  "_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.7,
    "volume": 1,
    "temperature": 0.7
  },
  "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

Speed value for TTS narration (0 to 1).

settings.volumenumber

Volume level for TTS (0 to 1).

settings.temperaturenumber

Temperature for LLM creativity (0 to 1).

statusstring

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

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.