Get Agent By Id

Retrieve an Agent by ID

curl --request GET \
  --url https://api.trugen.ai/v1/agent/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "b63c2a53-266b-4b43-a71b-7ea8b5e2e916",
  "agent_name": "Customer Support Agent",
  "agent_system_prompt": "You are a helpful AI assistant that handles customer service inquiries.",
  "avatars": [
    {
      "avatar_key_id": "1e4ea106",
      "persona_name": "Sofia - Friendly Support",
      "persona_prompt": "Speak in a warm, engaging tone and provide clear answers.",
      "config": {
        "llm": {
          "model": "meta-llama/llama-4-maverick-17b-128e-instruct",
          "provider": "groq"
        },
        "stt": {
          "model": "flux-general-en",
          "provider": "deepgram",
          "min_endpointing_delay": 0.3,
          "max_endpointing_delay": 0.4
        },
        "tts": {
          "model_id": "eleven_turbo_v2_5",
          "provider": "elevenlabs",
          "voice_id": "ZUrEGyu8GFMwnHbvLhv2"
        }
      }
    }
  ],
  "callback_events": [
    "participant_left",
    "agent.started_speaking",
    "agent.stopped_speaking",
    "agent.interrupted",
    "user.started_speaking",
    "user.stopped_speaking",
    "utterance_committed",
    "max_call_duration_timeout"
  ],
  "callback_url": "https://webhooks.example.com/agent-events",
  "config": {
    "systemPrompt": "Always respond with a concise solution first, then provide optional detail.",
    "maxCallDuration": 1800,
    "conversationalContext": "customer-support"
  },
  "knowledge_base": [
    {
      "id": "ac79226e-73e1-41fe-8cde-469ae4e244fa",
      "name": "Product Support Articles",
      "description": "Contains FAQs and troubleshooting guides for product lines."
    }
  ],
  "record": true,
  "created_at": "2025-12-01T10:20:30.000Z",
  "updated_at": "2025-12-03T14:50:00.000Z"
}

GET

agent

{id}

Retrieve an Agent by ID

curl --request GET \
  --url https://api.trugen.ai/v1/agent/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "b63c2a53-266b-4b43-a71b-7ea8b5e2e916",
  "agent_name": "Customer Support Agent",
  "agent_system_prompt": "You are a helpful AI assistant that handles customer service inquiries.",
  "avatars": [
    {
      "avatar_key_id": "1e4ea106",
      "persona_name": "Sofia - Friendly Support",
      "persona_prompt": "Speak in a warm, engaging tone and provide clear answers.",
      "config": {
        "llm": {
          "model": "meta-llama/llama-4-maverick-17b-128e-instruct",
          "provider": "groq"
        },
        "stt": {
          "model": "flux-general-en",
          "provider": "deepgram",
          "min_endpointing_delay": 0.3,
          "max_endpointing_delay": 0.4
        },
        "tts": {
          "model_id": "eleven_turbo_v2_5",
          "provider": "elevenlabs",
          "voice_id": "ZUrEGyu8GFMwnHbvLhv2"
        }
      }
    }
  ],
  "callback_events": [
    "participant_left",
    "agent.started_speaking",
    "agent.stopped_speaking",
    "agent.interrupted",
    "user.started_speaking",
    "user.stopped_speaking",
    "utterance_committed",
    "max_call_duration_timeout"
  ],
  "callback_url": "https://webhooks.example.com/agent-events",
  "config": {
    "systemPrompt": "Always respond with a concise solution first, then provide optional detail.",
    "maxCallDuration": 1800,
    "conversationalContext": "customer-support"
  },
  "knowledge_base": [
    {
      "id": "ac79226e-73e1-41fe-8cde-469ae4e244fa",
      "name": "Product Support Articles",
      "description": "Contains FAQs and troubleshooting guides for product lines."
    }
  ],
  "record": true,
  "created_at": "2025-12-01T10:20:30.000Z",
  "updated_at": "2025-12-03T14:50:00.000Z"
}

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

Unique identifier for the Agent

Response

Agent retrieved successfully

string<uuid>

Unique identifier for the agent.

Example:

"b63c2a53-266b-4b43-a71b-7ea8b5e2e916"

agent_name

string

Display name of the agent.

Example:

"Customer Support Agent"

agent_system_prompt

string

Foundational system instruction used by this agent.

Example:

"You are a helpful AI assistant that handles customer service inquiries."

avatars

object[]

List of avatars associated with this agent.

Show child attributes

avatars.avatar_key_id

string

Avatar identifier key.

Example:

"1e4ea106"

avatars.persona_name

string

Display name for the avatar persona.

Example:

"Sofia - Friendly Support"

avatars.persona_prompt

string

Behavioral prompt for the avatar interaction style.

Example:

"Speak in a warm, engaging tone and provide clear answers."

avatars.config

object

Configuration for avatar behavior and runtime settings.

Show child attributes

avatars.config.llm

object

Large Language Model settings used by the avatar.

Show child attributes

avatars.config.llm.model

string

Identifier of the LLM model.

Example:

"meta-llama/llama-4-maverick-17b-128e-instruct"

avatars.config.llm.provider

string

Provider used for LLM inference.

Example:

"groq"

avatars.config.stt

object

Speech-to-Text model configuration.

Show child attributes

avatars.config.stt.model

string

Speech recognition model identifier.

Example:

"flux-general-en"

avatars.config.stt.provider

string

STT provider service name.

Example:

"deepgram"

avatars.config.stt.min_endpointing_delay

number

Minimum endpointing delay in seconds.

Example:

0.3

avatars.config.stt.max_endpointing_delay

number

Maximum endpointing delay in seconds.

Example:

0.4

avatars.config.tts

object

Text-to-Speech generation configuration.

Show child attributes

avatars.config.tts.model_id

string

Voice synthesis model identifier.

Example:

"eleven_turbo_v2_5"

avatars.config.tts.provider

string

TTS provider service name.

Example:

"elevenlabs"

avatars.config.tts.voice_id

string

Voice ID used to synthesize speech.

Example:

"ZUrEGyu8GFMwnHbvLhv2"

callback_events

string[]

Webhook events that should trigger callbacks.

Example:

[
  "participant_left",
  "agent.started_speaking",
  "agent.stopped_speaking",
  "agent.interrupted",
  "user.started_speaking",
  "user.stopped_speaking",
  "utterance_committed",
  "max_call_duration_timeout"
]

callback_url

string

Webhook endpoint URL to send callback events to.

Example:

"https://webhooks.example.com/agent-events"

config

object

Agent-level configuration properties.

Show child attributes

config.systemPrompt

string

System prompt value stored within config.

Example:

"Always respond with a concise solution first, then provide optional detail."

config.maxCallDuration

integer

Maximum call duration allowed in seconds.

Example:

1800

config.conversationalContext

string

Context label used to maintain continuity across sessions.

Example:

"customer-support"

knowledge_base

object[] | null

List of knowledge bases attached to this agent.

Show child attributes

knowledge_base.id

string<uuid>

Knowledge base identifier.

Example:

"ac79226e-73e1-41fe-8cde-469ae4e244fa"

knowledge_base.name

string

Name of the knowledge base.

Example:

"Product Support Articles"

knowledge_base.description

string

Short summary of the knowledge base content.

Example:

"Contains FAQs and troubleshooting guides for product lines."

record

boolean

Determines whether voice call recordings should be stored.

Example:

true

created_at

string<date-time>

Timestamp indicating when the agent was created.

Example:

"2025-12-01T10:20:30.000Z"

updated_at

string<date-time>

Last updated timestamp for the agent.

Example:

"2025-12-03T14:50:00.000Z"

Create Agent By Template List All Agents

⌘I

API Documentation

Video Agents

Persona Templates

Knowledge Base

Providers

Avatars

Authorizations

Path Parameters

Response