Agents
Get Agent Version
Get Agent Version with the DialNexa API. Returns one version of an agent owned by your workspace. Use this to inspect a published or draft configuration.
GET
/
v1
/
agent-versions
/
{agentId}
/
version
/
{versionNumber}
Get Agent Version
curl --request GET \
--url https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"error": false,
"statusCode": 200,
"message": "Success",
"data": {
"agent_id": "<string>",
"version_number": 123,
"version_title": "<string>",
"title": "<string>",
"description": "<string>",
"inbound_telephony_provider_id": "<string>",
"llm_id": "<string>",
"outbound_telephony_provider_id": "<string>",
"language_id": "<string>",
"voice_id": "<string>",
"voice_model_id": "<string>",
"voice_speed": 123,
"voice_temperature": 123,
"voice_volume": 123,
"voice_pitch": 123,
"prompt_text": "<string>",
"system_prompt_text": "<string>",
"conversation_start_type": "<string>",
"welcome_message": "<string>",
"allow_interruptions": true,
"json_output_instructions": null,
"knowledge_base_ids": [
"<string>"
],
"kb_max_chunks": 123,
"kb_min_score": 123,
"is_published": true,
"voicemail_detection": true,
"hangup_on_voicemail": true,
"voicemail_message": "<string>",
"listen_for_keypad": true,
"structured_output": true,
"keypad_timeout_sec": 123,
"termination_key": "<string>",
"digit_limit": 123,
"end_call_on_silence_sec": 123,
"max_call_duration_sec": 123,
"ring_duration_sec": 123,
"background_sound": "<string>",
"ambient_noise": true,
"background_sound_volume": 123,
"llm_temperature": 123,
"fallback_llm_enabled": true,
"llm_fallback_delay_ms": 123,
"llm_fallback_model": "<string>",
"fallback_stt_enabled": true,
"stt_fallback_wait_ms": 123,
"stt_fallback_transcriber_id": "<string>",
"predictive_preprocessing_enabled": true,
"prompt_caching_enabled": true,
"responsiveness": 123,
"interruption_sensitivity": 123,
"response_eagerness": 123,
"backchanneling": true,
"backchannel_frequency": 123,
"transcription_mode": "<string>",
"transcriber_id": "<string>",
"denoising_mode": "<string>",
"denoise_strength": 123,
"speech_normalization": true,
"transcript_formatting": true,
"backchannel_keywords": "<string>",
"boosted_keywords": "<string>",
"boost_dynamic_variables": true,
"reminder_message_interval": 123,
"reminder_message_frequency": 123,
"reminder_message_content": "<string>",
"default_dynamic_variables": null,
"call_transfer_settings": null,
"agent_identity": "<string>",
"agent_background": "<string>",
"node_positions": "<string>",
"ivr_menu": {},
"opt_out_sensitive_data_storage": true,
"opt_in_secure_urls": true,
"audio_cache_enabled": true,
"fallback_voices": [
"<unknown>"
],
"pause_before_speaking_sec": 123,
"agent": {},
"language": {},
"voice": {},
"inbound_telephony_number": {},
"outbound_telephony_number": {},
"llm": {},
"voice_model": {},
"transcriber": {},
"stt_fallback_transcriber": {}
},
"timestamp": "2023-11-07T05:31:56Z"
}Read only
Get Agent Version uses your workspace API key. Returns one version of an agent owned by your workspace. Use this to inspect a published or draft configuration.
Before you begin
Use a server-side API key for the intended workspace. Replace each path placeholder with an existing resource ID or version number from that workspace.Get Agent Version request
The request panel lists supported query parameters and body fields. For a request body, the example below supplies the required fields. Replace sample values with your own inputs.curl --request GET 'https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}' \
--header "Authorization: Bearer $DIALNEXA_API_KEY"
Verify the result
Expect HTTP200. Read the data property in the success envelope; the response panel documents its fields.
Retry safety
This operation does not modify workspace resources. Retry after a transient connection failure.Errors and recovery
401: Missing, expired, or invalid API key.
Related endpoints
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
⌘I
Get Agent Version
curl --request GET \
--url https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dialnexa.com/v1/agent-versions/{agentId}/version/{versionNumber}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"error": false,
"statusCode": 200,
"message": "Success",
"data": {
"agent_id": "<string>",
"version_number": 123,
"version_title": "<string>",
"title": "<string>",
"description": "<string>",
"inbound_telephony_provider_id": "<string>",
"llm_id": "<string>",
"outbound_telephony_provider_id": "<string>",
"language_id": "<string>",
"voice_id": "<string>",
"voice_model_id": "<string>",
"voice_speed": 123,
"voice_temperature": 123,
"voice_volume": 123,
"voice_pitch": 123,
"prompt_text": "<string>",
"system_prompt_text": "<string>",
"conversation_start_type": "<string>",
"welcome_message": "<string>",
"allow_interruptions": true,
"json_output_instructions": null,
"knowledge_base_ids": [
"<string>"
],
"kb_max_chunks": 123,
"kb_min_score": 123,
"is_published": true,
"voicemail_detection": true,
"hangup_on_voicemail": true,
"voicemail_message": "<string>",
"listen_for_keypad": true,
"structured_output": true,
"keypad_timeout_sec": 123,
"termination_key": "<string>",
"digit_limit": 123,
"end_call_on_silence_sec": 123,
"max_call_duration_sec": 123,
"ring_duration_sec": 123,
"background_sound": "<string>",
"ambient_noise": true,
"background_sound_volume": 123,
"llm_temperature": 123,
"fallback_llm_enabled": true,
"llm_fallback_delay_ms": 123,
"llm_fallback_model": "<string>",
"fallback_stt_enabled": true,
"stt_fallback_wait_ms": 123,
"stt_fallback_transcriber_id": "<string>",
"predictive_preprocessing_enabled": true,
"prompt_caching_enabled": true,
"responsiveness": 123,
"interruption_sensitivity": 123,
"response_eagerness": 123,
"backchanneling": true,
"backchannel_frequency": 123,
"transcription_mode": "<string>",
"transcriber_id": "<string>",
"denoising_mode": "<string>",
"denoise_strength": 123,
"speech_normalization": true,
"transcript_formatting": true,
"backchannel_keywords": "<string>",
"boosted_keywords": "<string>",
"boost_dynamic_variables": true,
"reminder_message_interval": 123,
"reminder_message_frequency": 123,
"reminder_message_content": "<string>",
"default_dynamic_variables": null,
"call_transfer_settings": null,
"agent_identity": "<string>",
"agent_background": "<string>",
"node_positions": "<string>",
"ivr_menu": {},
"opt_out_sensitive_data_storage": true,
"opt_in_secure_urls": true,
"audio_cache_enabled": true,
"fallback_voices": [
"<unknown>"
],
"pause_before_speaking_sec": 123,
"agent": {},
"language": {},
"voice": {},
"inbound_telephony_number": {},
"outbound_telephony_number": {},
"llm": {},
"voice_model": {},
"transcriber": {},
"stt_fallback_transcriber": {}
},
"timestamp": "2023-11-07T05:31:56Z"
}