GET
/
v1
/
api
/
agents
/
{agentId}
Get Call Agent
curl --request GET \
  --url https://api.trillet.ai/v1/api/agents/{agentId} \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "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",
  "__v": 0
}

Headers

x-api-key
string
required
API key used for authenticating requests to the API.
x-workspace-id
string
required
Workspace identifier for the API.

Path Parameters

agentId
string
required
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",
  "__v": 0
}

Response Fields

ttsModel
object
Contains the text-to-speech model details.
ttsModel.language
string
The language of the voice model (e.g., en).
ttsModel.provider
string
The TTS provider name (e.g., openai, cartesia).
ttsModel.voiceId
string
The unique identifier for the voice model.
ttsModel.name
string
The name of the voice model.
_id
string
Unique identifier for the agent.
workspaceId
string
Unique identifier for the workspace associated with the agent.
userId
string
Unique identifier for the user associated with the agent.
name
string
Name of the agent.
llmModel
string
The LLM (language model) used by the agent (e.g., gpt-4o-mini).
type
string
Type of agent (e.g., voice).
settings
object
The settings for the agent, including speed, volume, and temperature.
settings.speed
number
Speed value for TTS narration (0 to 1).
settings.volume
number
Volume level for TTS (0 to 1).
settings.temperature
number
Temperature for LLM creativity (0 to 1).
status
string
The current status of the agent (e.g., ready).
activeSessions
array
A list of active sessions associated with the agent.
createdAt
string
The timestamp when the agent was created.
updatedAt
string
The timestamp when the agent was last updated.
__v
number
The internal version field (if used).