Import Agents
curl --request POST \
--url https://api.revring.ai/v1/imports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"apiKey": "<string>",
"agentIds": [
"<string>"
],
"dryRun": true
}
'import requests
url = "https://api.revring.ai/v1/imports"
payload = {
"apiKey": "<string>",
"agentIds": ["<string>"],
"dryRun": True
}
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({apiKey: '<string>', agentIds: ['<string>'], dryRun: true})
};
fetch('https://api.revring.ai/v1/imports', 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/imports",
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([
'apiKey' => '<string>',
'agentIds' => [
'<string>'
],
'dryRun' => true
]),
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/imports"
payload := strings.NewReader("{\n \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\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/imports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/imports")
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 \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"platform": "retell",
"dryRun": true,
"agents": [
{
"source": {
"platform": "<string>",
"agentId": "<string>",
"name": "<string>"
},
"status": "ready",
"blockedReason": "<string>",
"error": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"action": "created"
},
"voice": {
"status": "mapped",
"source": "<string>",
"target": "<string>",
"detail": "<string>"
},
"customTools": [
{
"name": "<string>",
"webhookUrl": "<string>"
}
],
"knowledgeBases": [
{
"name": "<string>",
"sources": 123
}
],
"counts": {
"mapped": 123,
"approximated": 123,
"unsupported": 123,
"manual": 123
},
"fields": [
{
"field": "<string>",
"status": "mapped",
"target": "<string>",
"detail": "<string>"
}
],
"checklist": [
"<string>"
]
}
],
"summary": {
"agents": 123,
"ready": 123,
"blocked": 123,
"imported": 123,
"failed": 123
}
}
}{
"data": {
"platform": "retell",
"dryRun": true,
"agents": [
{
"source": {
"platform": "<string>",
"agentId": "<string>",
"name": "<string>"
},
"status": "ready",
"blockedReason": "<string>",
"error": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"action": "created"
},
"voice": {
"status": "mapped",
"source": "<string>",
"target": "<string>",
"detail": "<string>"
},
"customTools": [
{
"name": "<string>",
"webhookUrl": "<string>"
}
],
"knowledgeBases": [
{
"name": "<string>",
"sources": 123
}
],
"counts": {
"mapped": 123,
"approximated": 123,
"unsupported": 123,
"manual": 123
},
"fields": [
{
"field": "<string>",
"status": "mapped",
"target": "<string>",
"detail": "<string>"
}
],
"checklist": [
"<string>"
]
}
],
"summary": {
"agents": 123,
"ready": 123,
"blocked": 123,
"imported": 123,
"failed": 123
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Imports
Import Agents
Import agents from Retell AI or ElevenLabs Agents. A dry run (the default) returns a per-setting report and creates nothing. With dryRun: false the agents are created with their custom tools and knowledge bases. Importing an agent again updates the agent it created before.
POST
/
imports
Import Agents
curl --request POST \
--url https://api.revring.ai/v1/imports \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"apiKey": "<string>",
"agentIds": [
"<string>"
],
"dryRun": true
}
'import requests
url = "https://api.revring.ai/v1/imports"
payload = {
"apiKey": "<string>",
"agentIds": ["<string>"],
"dryRun": True
}
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({apiKey: '<string>', agentIds: ['<string>'], dryRun: true})
};
fetch('https://api.revring.ai/v1/imports', 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/imports",
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([
'apiKey' => '<string>',
'agentIds' => [
'<string>'
],
'dryRun' => true
]),
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/imports"
payload := strings.NewReader("{\n \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\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/imports")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revring.ai/v1/imports")
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 \"apiKey\": \"<string>\",\n \"agentIds\": [\n \"<string>\"\n ],\n \"dryRun\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"platform": "retell",
"dryRun": true,
"agents": [
{
"source": {
"platform": "<string>",
"agentId": "<string>",
"name": "<string>"
},
"status": "ready",
"blockedReason": "<string>",
"error": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"action": "created"
},
"voice": {
"status": "mapped",
"source": "<string>",
"target": "<string>",
"detail": "<string>"
},
"customTools": [
{
"name": "<string>",
"webhookUrl": "<string>"
}
],
"knowledgeBases": [
{
"name": "<string>",
"sources": 123
}
],
"counts": {
"mapped": 123,
"approximated": 123,
"unsupported": 123,
"manual": 123
},
"fields": [
{
"field": "<string>",
"status": "mapped",
"target": "<string>",
"detail": "<string>"
}
],
"checklist": [
"<string>"
]
}
],
"summary": {
"agents": 123,
"ready": 123,
"blocked": 123,
"imported": 123,
"failed": 123
}
}
}{
"data": {
"platform": "retell",
"dryRun": true,
"agents": [
{
"source": {
"platform": "<string>",
"agentId": "<string>",
"name": "<string>"
},
"status": "ready",
"blockedReason": "<string>",
"error": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"action": "created"
},
"voice": {
"status": "mapped",
"source": "<string>",
"target": "<string>",
"detail": "<string>"
},
"customTools": [
{
"name": "<string>",
"webhookUrl": "<string>"
}
],
"knowledgeBases": [
{
"name": "<string>",
"sources": 123
}
],
"counts": {
"mapped": 123,
"approximated": 123,
"unsupported": 123,
"manual": 123
},
"fields": [
{
"field": "<string>",
"status": "mapped",
"target": "<string>",
"detail": "<string>"
}
],
"checklist": [
"<string>"
]
}
],
"summary": {
"agents": 123,
"ready": 123,
"blocked": 123,
"imported": 123,
"failed": 123
}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}See Import Agents for what carries over and how to read the report.
Authorizations
API key for authentication. Generate API keys from the RevRing dashboard.
Body
application/json
Platform the agents are on
Available options:
retell, elevenlabs Your API key for the source platform. Used for read-only requests during this request only; never stored, logged or returned.
Source agent IDs. Up to 25 on a dry run, up to 10 when importing.
Required array length:
1 - 25 elementsElevenLabs only: the data-residency region the agents live in. Default default.
Available options:
default, us, eu, in, sg Report only; create nothing
Response
Dry run report
Show child attributes
Show child attributes