Get voice agent details

curl --request GET \
  --url https://api.getkarta.ai/public/v1/voice/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getkarta.ai/public/v1/voice/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agentId": "agentexample",
  "customerDetails": {
    "dataResidencyRegion": "IN"
  },
  "languageConfig": {
    "primaryLanguage": "en",
    "secondaryLanguages": []
  },
  "languageDefaultsConfig": null,
  "agentDetails": {
    "instructions": "SGVscCBjdXN0b21lcnMgd2l0aCB0aGVpciBxdWVzdGlvbnMu",
    "dynamicVariables": [],
    "agentName": "Example support agent",
    "updatedAt": null
  },
  "welcomeMessageConfig": null,
  "STTConfigs": [],
  "agentVoiceConfigs": [],
  "experimental": {
    "ttsCache": true
  },
  "pronunciationDictionaryConfigs": null,
  "LLMConfigs": [],
  "ToolsConfig": [],
  "CustomToolsConfig": [],
  "inboundWebhookConfigs": [],
  "SpeechConfigs": {
    "responsiveness": 1,
    "interruptionSensitivity": 1,
    "idleUserTimeoutMs": 10000,
    "minConsecutiveSpeechDelay": 1,
    "discardAudioDuringInterruption": true,
    "maxEndpointingDelayBase": 2.5,
    "endpointingMode": "fixed",
    "dtmfEnabled": false,
    "toolEngagingMessageEnabled": false
  },
  "turnDetectionConfigs": {
    "turnDetectionModel": "vad",
    "modelConfig": {}
  },
  "PostCallAnalysisConfigs": [],
  "voicemailDetectionConfig": {
    "detection_duration_ms": 3000,
    "llm_settings": {}
  },
  "agentKBConfig": {
    "topn": 3,
    "enableKB": false
  },
  "agentContextConfig": {
    "kbStoreConfig": {
      "maxChunkCount": 10,
      "maxToken": 5000
    }
  },
  "intentConfig": {
    "enableIntentWorkflow": false,
    "intentIdentificationConfig": {
      "instructions": "",
      "intentThreshold": 0.4,
      "categories": [],
      "categoryDescription": ""
    },
    "intentEscalationConfig": {
      "instructions": ""
    }
  },
  "widgetConfig": null,
  "useNumberPool": false,
  "createdAt": null,
  "updatedAt": null,
  "postCallWorkFlow": []
}

GET

voice

agents

{agent_id}

Get voice agent details

curl --request GET \
  --url https://api.getkarta.ai/public/v1/voice/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getkarta.ai/public/v1/voice/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agentId": "agentexample",
  "customerDetails": {
    "dataResidencyRegion": "IN"
  },
  "languageConfig": {
    "primaryLanguage": "en",
    "secondaryLanguages": []
  },
  "languageDefaultsConfig": null,
  "agentDetails": {
    "instructions": "SGVscCBjdXN0b21lcnMgd2l0aCB0aGVpciBxdWVzdGlvbnMu",
    "dynamicVariables": [],
    "agentName": "Example support agent",
    "updatedAt": null
  },
  "welcomeMessageConfig": null,
  "STTConfigs": [],
  "agentVoiceConfigs": [],
  "experimental": {
    "ttsCache": true
  },
  "pronunciationDictionaryConfigs": null,
  "LLMConfigs": [],
  "ToolsConfig": [],
  "CustomToolsConfig": [],
  "inboundWebhookConfigs": [],
  "SpeechConfigs": {
    "responsiveness": 1,
    "interruptionSensitivity": 1,
    "idleUserTimeoutMs": 10000,
    "minConsecutiveSpeechDelay": 1,
    "discardAudioDuringInterruption": true,
    "maxEndpointingDelayBase": 2.5,
    "endpointingMode": "fixed",
    "dtmfEnabled": false,
    "toolEngagingMessageEnabled": false
  },
  "turnDetectionConfigs": {
    "turnDetectionModel": "vad",
    "modelConfig": {}
  },
  "PostCallAnalysisConfigs": [],
  "voicemailDetectionConfig": {
    "detection_duration_ms": 3000,
    "llm_settings": {}
  },
  "agentKBConfig": {
    "topn": 3,
    "enableKB": false
  },
  "agentContextConfig": {
    "kbStoreConfig": {
      "maxChunkCount": 10,
      "maxToken": 5000
    }
  },
  "intentConfig": {
    "enableIntentWorkflow": false,
    "intentIdentificationConfig": {
      "instructions": "",
      "intentThreshold": 0.4,
      "categories": [],
      "categoryDescription": ""
    },
    "intentEscalationConfig": {
      "instructions": ""
    }
  },
  "widgetConfig": null,
  "useNumberPool": false,
  "createdAt": null,
  "updatedAt": null,
  "postCallWorkFlow": []
}

Keep returned credentials private.

Authorizations

Authorization

string

header

required

API key in the format: Bearer YOUR_KARTA_API_KEY.

Headers

X-Request-ID

string

Optional request-tracing identifier.

Path Parameters

agent_id

string

required

Voice agent ID returned by List agents; underscores are not supported.

Response

Successful response.

Voice agent configuration.

agentId

string | null

Agent identifier

customerDetails

CustomerDetails · object

Customer configuration

Show child attributes

languageConfig

LanguageConfig · object

Language configuration

Show child attributes

languageDefaultsConfig

LanguageDefaults · object | null

Optional per-language default message configuration

Show child attributes

agentDetails

AgentDetails · object

Agent details configuration

Show child attributes

welcomeMessageConfig

WelcomeMessageConfig · object | null

Welcome message behaviour configuration

Show child attributes

STTConfigs

STTConfigEntry · object[]

List of STT provider configurations for this agent

Show child attributes

agentVoiceConfigs

AgentVoiceConfig · object[]

List of voice configurations for this agent

Show child attributes

experimental

Experimental · object

Experimental feature flags

pronunciationDictionaryConfigs

PronunciationDictionaryConfig · object | null

Pronunciation dictionary config with rules and provider metadata

Show child attributes

LLMConfigs

LLMPConfigEntry · object[]

List of LLM provider configurations for this agent

Show child attributes

ToolsConfig

ToolConfigEntry · object[]

List of tool configurations available to the agent

Show child attributes

CustomToolsConfig

CustomToolConfig · object[]

List of custom tool configurations available to the agent

Show child attributes

inboundWebhookConfigs

InboundWebhookConfig · object[]

List of inbound webhook configurations for the agent

Show child attributes

SpeechConfigs

SpeechConfigEntry · object

Speech configurations for this agent

Show child attributes

turnDetectionConfigs

TurnDetectionConfigEntry · object

Turn detection configurations for this agent

Show child attributes

PostCallAnalysisConfigs

PostCallAnalysisConfigEntry · object[]

List of post call analysis configurations for this agent

Show child attributes

voicemailDetectionConfig

VoicemailDetectionConfigEntry · object

Voicemail detection configuration for this agent

Show child attributes

agentKBConfig

AgentKBConfigEntry · object

Knowledge base configuration for this agent

Show child attributes

agentContextConfig

AgentContextConfigEntry · object

Agent context configuration for this agent

Show child attributes

intentConfig

IntentConfigEntry · object

Intent identification and escalation configuration

Show child attributes

Widget configuration for the agent

Show child attributes

useNumberPool

boolean

default:false

Use a random eligible caller ID for outbound calls

createdAt

string<date-time> | null

Creation timestamp

updatedAt

string<date-time> | null

Last update timestamp

postCallWorkFlow

Postcallworkflow · object[] | null

List of post call workflow configurations for this agent

Get started

Account

Agents

Calls

Phone numbers

Campaigns

WebSocket sessions

Billing

Webhooks

Get voice agent details

Authorizations

Headers

Path Parameters

Response