Batch Get Agents
curl --request POST \
--url https://api.revring.ai/v1/agents/batch-get \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"ids": [
"<string>"
],
"minimal": false
}
'import requests
url = "https://api.revring.ai/v1/agents/batch-get"
payload = {
"ids": ["<string>"],
"minimal": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ids: ['<string>'], minimal: false})
};
fetch('https://api.revring.ai/v1/agents/batch-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://api.revring.ai/v1/agents/batch-get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'minimal' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.revring.ai/v1/agents/batch-get"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.revring.ai/v1/agents/batch-get")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/agents/batch-get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"promptTemplate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"messagingConnectionId": "<string>",
"messagingConfig": {
"smsPrompt": "<string>",
"inboundMode": "auto_reply",
"inboundWebhookUrl": "<string>",
"fromNumber": "<string>",
"sendMessageEnabled": true,
"sendMessageDescriptionOverride": "<string>",
"conversationIdleResetDays": 123
},
"widgetKey": "<string>",
"widgetConfig": {
"enabled": true,
"modes": {
"chat": true,
"voice": true
},
"continuity": {
"resumeCalls": true,
"sharedMemory": true
},
"allowedDomains": [
"<string>"
],
"webchatPrompt": "<string>",
"appearance": {
"position": "bottom-right",
"accentColor": "<string>",
"theme": "light",
"launcherLabel": "<string>",
"agentDisplayName": "<string>",
"avatarUrl": "<string>",
"welcomeMessage": "<string>",
"chatPlaceholder": "<string>"
},
"limits": {
"messagesPerDay": 123
}
},
"sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sipTrunk": {
"friendlyName": "<string>"
},
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
},
"defaultVariables": {},
"firstMessage": "<string>",
"firstMessageOutbound": "<string>",
"firstMessageDelayMs": 7500,
"startSpeaker": "agent",
"startSpeakerOutbound": "agent",
"firstMessageDelayMsOutbound": 7500,
"beginAfterUserSilenceMs": 30250,
"firstMessageMode": "static",
"turnTimeoutSeconds": 123,
"silenceEndCallTimeoutSeconds": 123,
"maxConversationDurationSeconds": 123,
"llmTemperature": 1,
"llmModel": "revring-standard",
"timezone": "<string>",
"language": "<string>",
"preCallWebhookUrl": "<string>",
"postCallWebhookUrl": "<string>",
"postCallWebhookFormat": "revring",
"webhookEvents": [
"call.started"
],
"postCallExtraction": {
"fields": [
{
"name": "callback_requested",
"description": "Did the caller ask to be called back?",
"type": "boolean"
},
{
"name": "preferred_day",
"description": "Day of the week the caller prefers for the callback",
"type": "enum",
"values": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
{
"name": "budget",
"description": "Budget the caller mentioned, in dollars",
"type": "number"
}
]
},
"postCallEvaluation": {
"criteria": [
{
"name": "appointment_confirmed",
"description": "The caller confirmed an appointment date and time"
},
{
"name": "callback_requested",
"description": "The caller asked to be called back"
}
]
},
"storageMode": "full",
"piiCategories": [
"person_name"
],
"publishMode": "auto",
"publishedRevision": 123,
"hasUnpublishedChanges": true,
"endCallEnabled": true,
"endCallRulesOverride": "<string>",
"transferEnabled": true,
"transferRoutes": [
{
"to_number": "<string>",
"condition": "<string>",
"extension": "<string>",
"dialTimeoutSeconds": 155,
"waitForHumanSeconds": 307
}
],
"transferDescriptionOverride": "<string>",
"voicemailEnabled": true,
"voicemailAction": "hangup",
"voicemailMessage": "<string>",
"voiceId": "<string>",
"fallbackVoiceId": "<string>",
"voiceTemperature": 0.5,
"voiceSpeed": 1.25,
"voiceVolume": 0,
"voiceTopP": 0.5,
"runtimeConfig": {},
"phoneNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"e164": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"environment": "<string>",
"trafficSplit": [
{
"environment": "<string>",
"weight": 50
}
]
}
],
"customTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"webhookUrl": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"schema": {},
"httpMethod": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"queryParams": [
{
"key": "<string>",
"value": "<string>"
}
],
"sendRawRequestBody": true,
"responseMode": "sync",
"timeoutSeconds": 60,
"executionMessage": "<string>",
"responseVariables": [
{
"name": "<string>",
"path": "<string>"
}
],
"speakAfterResult": true,
"maxRetries": 0
}
],
"mode": "single_prompt",
"flowDefinition": {},
"testVariables": {},
"llmReasoningEffort": "low",
"disableInterruptions": true,
"interruptionThresholdMs": 500,
"interruptionIgnoreWords": [
"<string>"
],
"sttKeyterms": [
"<string>"
],
"noiseCancellation": "on",
"minInterruptionWords": 1,
"transferMode": "cold",
"warmTransferConfig": {
"holdMessage": "<string>",
"holdMusicEnabled": true,
"summaryPrompt": "<string>",
"introMessage": "<string>",
"continueRecordingAfterTransfer": true,
"callerIdMode": "agent",
"dialTimeoutSeconds": 155,
"waitForHumanSeconds": 307
},
"playKeypadTouchToneEnabled": true,
"playKeypadTouchToneDescriptionOverride": "<string>",
"knowledgeBaseRetrievalMode": "automatic",
"knowledgeBaseChunks": 10,
"knowledgeBaseSimilarityThreshold": 0.5,
"languagePresets": {},
"doNotCallDetection": false,
"inboundCallbacks": {
"enabled": true,
"windowDays": 45,
"greeting": "<string>"
},
"contactMemory": {
"read": true,
"update": true
},
"guardrails": {
"focus": {
"enabled": true,
"scope": "<string>"
},
"manipulation": {
"enabled": true
},
"blockedTopics": [
"<string>"
],
"onViolation": "redirect"
},
"booking": {
"integrationId": "<string>",
"calendarId": "<string>",
"durationMinutes": 242,
"timeZone": "<string>"
},
"handoffRoutes": [
{
"agentId": "<string>",
"condition": "<string>",
"environment": "<string>",
"keepVoice": true,
"handoffMessage": "<string>"
}
],
"mcpServers": [
{
"name": "<string>",
"url": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"allowedTools": [
"<string>"
],
"transport": "streamable_http",
"timeoutSeconds": 60
}
],
"recordingEnabled": true,
"pronunciations": [
{
"word": "<string>",
"alias": "<string>",
"caseSensitive": true
}
],
"keypadInput": {
"enabled": true,
"terminationKey": "#",
"digitLimit": 25,
"timeoutMs": 8000
},
"backchannels": true
}
]
}{
"error": "invalid_body",
"details": {}
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}Agents
Batch Get Agents
Fetch multiple agents by ID in a single request. Unknown IDs are omitted from the response. Maximum 100 IDs per request.
POST
/
agents
/
batch-get
Batch Get Agents
curl --request POST \
--url https://api.revring.ai/v1/agents/batch-get \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"ids": [
"<string>"
],
"minimal": false
}
'import requests
url = "https://api.revring.ai/v1/agents/batch-get"
payload = {
"ids": ["<string>"],
"minimal": False
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ids: ['<string>'], minimal: false})
};
fetch('https://api.revring.ai/v1/agents/batch-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://api.revring.ai/v1/agents/batch-get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'<string>'
],
'minimal' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.revring.ai/v1/agents/batch-get"
payload := strings.NewReader("{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.revring.ai/v1/agents/batch-get")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/agents/batch-get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"<string>\"\n ],\n \"minimal\": false\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"promptTemplate": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"messagingConnectionId": "<string>",
"messagingConfig": {
"smsPrompt": "<string>",
"inboundMode": "auto_reply",
"inboundWebhookUrl": "<string>",
"fromNumber": "<string>",
"sendMessageEnabled": true,
"sendMessageDescriptionOverride": "<string>",
"conversationIdleResetDays": 123
},
"widgetKey": "<string>",
"widgetConfig": {
"enabled": true,
"modes": {
"chat": true,
"voice": true
},
"continuity": {
"resumeCalls": true,
"sharedMemory": true
},
"allowedDomains": [
"<string>"
],
"webchatPrompt": "<string>",
"appearance": {
"position": "bottom-right",
"accentColor": "<string>",
"theme": "light",
"launcherLabel": "<string>",
"agentDisplayName": "<string>",
"avatarUrl": "<string>",
"welcomeMessage": "<string>",
"chatPlaceholder": "<string>"
},
"limits": {
"messagesPerDay": 123
}
},
"sipTrunkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sipTrunk": {
"friendlyName": "<string>"
},
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"folder": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
},
"defaultVariables": {},
"firstMessage": "<string>",
"firstMessageOutbound": "<string>",
"firstMessageDelayMs": 7500,
"startSpeaker": "agent",
"startSpeakerOutbound": "agent",
"firstMessageDelayMsOutbound": 7500,
"beginAfterUserSilenceMs": 30250,
"firstMessageMode": "static",
"turnTimeoutSeconds": 123,
"silenceEndCallTimeoutSeconds": 123,
"maxConversationDurationSeconds": 123,
"llmTemperature": 1,
"llmModel": "revring-standard",
"timezone": "<string>",
"language": "<string>",
"preCallWebhookUrl": "<string>",
"postCallWebhookUrl": "<string>",
"postCallWebhookFormat": "revring",
"webhookEvents": [
"call.started"
],
"postCallExtraction": {
"fields": [
{
"name": "callback_requested",
"description": "Did the caller ask to be called back?",
"type": "boolean"
},
{
"name": "preferred_day",
"description": "Day of the week the caller prefers for the callback",
"type": "enum",
"values": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
{
"name": "budget",
"description": "Budget the caller mentioned, in dollars",
"type": "number"
}
]
},
"postCallEvaluation": {
"criteria": [
{
"name": "appointment_confirmed",
"description": "The caller confirmed an appointment date and time"
},
{
"name": "callback_requested",
"description": "The caller asked to be called back"
}
]
},
"storageMode": "full",
"piiCategories": [
"person_name"
],
"publishMode": "auto",
"publishedRevision": 123,
"hasUnpublishedChanges": true,
"endCallEnabled": true,
"endCallRulesOverride": "<string>",
"transferEnabled": true,
"transferRoutes": [
{
"to_number": "<string>",
"condition": "<string>",
"extension": "<string>",
"dialTimeoutSeconds": 155,
"waitForHumanSeconds": 307
}
],
"transferDescriptionOverride": "<string>",
"voicemailEnabled": true,
"voicemailAction": "hangup",
"voicemailMessage": "<string>",
"voiceId": "<string>",
"fallbackVoiceId": "<string>",
"voiceTemperature": 0.5,
"voiceSpeed": 1.25,
"voiceVolume": 0,
"voiceTopP": 0.5,
"runtimeConfig": {},
"phoneNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"e164": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"environment": "<string>",
"trafficSplit": [
{
"environment": "<string>",
"weight": 50
}
]
}
],
"customTools": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"webhookUrl": "<string>",
"enabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"schema": {},
"httpMethod": "GET",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"queryParams": [
{
"key": "<string>",
"value": "<string>"
}
],
"sendRawRequestBody": true,
"responseMode": "sync",
"timeoutSeconds": 60,
"executionMessage": "<string>",
"responseVariables": [
{
"name": "<string>",
"path": "<string>"
}
],
"speakAfterResult": true,
"maxRetries": 0
}
],
"mode": "single_prompt",
"flowDefinition": {},
"testVariables": {},
"llmReasoningEffort": "low",
"disableInterruptions": true,
"interruptionThresholdMs": 500,
"interruptionIgnoreWords": [
"<string>"
],
"sttKeyterms": [
"<string>"
],
"noiseCancellation": "on",
"minInterruptionWords": 1,
"transferMode": "cold",
"warmTransferConfig": {
"holdMessage": "<string>",
"holdMusicEnabled": true,
"summaryPrompt": "<string>",
"introMessage": "<string>",
"continueRecordingAfterTransfer": true,
"callerIdMode": "agent",
"dialTimeoutSeconds": 155,
"waitForHumanSeconds": 307
},
"playKeypadTouchToneEnabled": true,
"playKeypadTouchToneDescriptionOverride": "<string>",
"knowledgeBaseRetrievalMode": "automatic",
"knowledgeBaseChunks": 10,
"knowledgeBaseSimilarityThreshold": 0.5,
"languagePresets": {},
"doNotCallDetection": false,
"inboundCallbacks": {
"enabled": true,
"windowDays": 45,
"greeting": "<string>"
},
"contactMemory": {
"read": true,
"update": true
},
"guardrails": {
"focus": {
"enabled": true,
"scope": "<string>"
},
"manipulation": {
"enabled": true
},
"blockedTopics": [
"<string>"
],
"onViolation": "redirect"
},
"booking": {
"integrationId": "<string>",
"calendarId": "<string>",
"durationMinutes": 242,
"timeZone": "<string>"
},
"handoffRoutes": [
{
"agentId": "<string>",
"condition": "<string>",
"environment": "<string>",
"keepVoice": true,
"handoffMessage": "<string>"
}
],
"mcpServers": [
{
"name": "<string>",
"url": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
],
"allowedTools": [
"<string>"
],
"transport": "streamable_http",
"timeoutSeconds": 60
}
],
"recordingEnabled": true,
"pronunciations": [
{
"word": "<string>",
"alias": "<string>",
"caseSensitive": true
}
],
"keypadInput": {
"enabled": true,
"terminationKey": "#",
"digitLimit": 25,
"timeoutMs": 8000
},
"backchannels": true
}
]
}{
"error": "invalid_body",
"details": {}
}{
"error": "unauthorized"
}{
"error": "billing_inactive"
}Authorizations
API key for authentication. Generate API keys from the RevRing dashboard. A key is either full access or read-only; a read-only key is refused with 403 read_only_key on any request that creates, changes or deletes.
Body
application/json
Response
Matching agents
Show child attributes
Show child attributes