Agents
curl --request GET \
--url https://svalync.com/api/agents/get \
--header 'x-api-key: <x-api-key>'import requests
url = "https://svalync.com/api/agents/get"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://svalync.com/api/agents/get', 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://svalync.com/api/agents/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$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://svalync.com/api/agents/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://svalync.com/api/agents/get")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://svalync.com/api/agents/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"response": [
{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"welcomeMessage": "<string>",
"task": "<string>",
"voice": "<string>",
"language": "<string>",
"telephonyProvider": {},
"callTermination": 123,
"hangupMessage": "<string>",
"apiTool": "<any>",
"knowledgeBase": "<string>",
"workflow": "<string>",
"userId": "<string>",
"inboundPhoneNumber": 123,
"createdAt": 123,
"updatedAt": 123
}
}
]
}Agent
Agents
Retrieve detailed Voice AI agent information, including configuration, status, and tasks, using Svalync’s API.
GET
/
agents
/
get
Agents
curl --request GET \
--url https://svalync.com/api/agents/get \
--header 'x-api-key: <x-api-key>'import requests
url = "https://svalync.com/api/agents/get"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://svalync.com/api/agents/get', 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://svalync.com/api/agents/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>"
],
]);
$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://svalync.com/api/agents/get"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://svalync.com/api/agents/get")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://svalync.com/api/agents/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"response": [
{
"success": true,
"data": {
"id": "<string>",
"name": "<string>",
"welcomeMessage": "<string>",
"task": "<string>",
"voice": "<string>",
"language": "<string>",
"telephonyProvider": {},
"callTermination": 123,
"hangupMessage": "<string>",
"apiTool": "<any>",
"knowledgeBase": "<string>",
"workflow": "<string>",
"userId": "<string>",
"inboundPhoneNumber": 123,
"createdAt": 123,
"updatedAt": 123
}
}
]
}Authorization
string
required
Your Api Key
Params
string
required
The unique identifier for the agent being retrieved.
Response
array
Show properties
Show properties
boolean
Indicates if the request was successful.
object
The created agent object containing all the input fields.
Show properties
Show properties
string
Unique identifier for the created agent.
string
The name assigned to the agent.
string
The message the agent speaks when a call is connected.
string
The purpose or function of the agent.
string
The voice setting configured for the agent.
string
The language the agent uses for communication.
12333
The provider used for handling incoming and outgoing calls.
integer
The condition or duration that triggers call termination.
string
The message played when the agent initiates a call hangup.
json
Configuration details for the API tool integrated with the agent.
string
Reference to the knowledge base associated with the agent.
string
The workflow process triggered after a call is completed.
string
The unique identifier for the user associated with the agent.
number
The phone number used for inbound calls to the agent.
number
The timestamp indicating when the agent was created.
number
The timestamp indicating when the agent was last updated.
⌘I