Agents
Retrieve detailed Voice AI agent information, including configuration, status, and tasks, using Svalync’s API.
curl --request GET \
--url https://svalync.com/api/agents/get \
--header 'x-api-key: <x-api-key>'{
"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
Your Api Key
Params
The unique identifier for the agent being retrieved.
Response
Indicates if the request was successful.
The created agent object containing all the input fields.
Unique identifier for the created agent.
The name assigned to the agent.
The message the agent speaks when a call is connected.
The purpose or function of the agent.
The voice setting configured for the agent.
The language the agent uses for communication.
The provider used for handling incoming and outgoing calls.
The condition or duration that triggers call termination.
The message played when the agent initiates a call hangup.
Configuration details for the API tool integrated with the agent.
Reference to the knowledge base associated with the agent.
The workflow process triggered after a call is completed.
The unique identifier for the user associated with the agent.
The phone number used for inbound calls to the agent.
The timestamp indicating when the agent was created.
The timestamp indicating when the agent was last updated.
curl --request GET \
--url https://svalync.com/api/agents/get \
--header 'x-api-key: <x-api-key>'{
"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
}
}
]
}