Get Assistant By ID
Retrieves detailed information about a specific assistant by its ID.
GET
/
agent
/
{agent_id}
Get Assistant By ID
curl --request GET \
--url https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id} \
--header 'X-API-KEY: <x-api-key>'import requests
url = "https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}"
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}', 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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}",
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}"
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}")
.header("X-API-KEY", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}")
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{
"agents": {
"id": "830f767a-397e-4b39-82ff-235cd344e2f9",
"agent_display_name": "Sales Assistant",
"agent_type": "outbound",
"whitelisted_domains": [
"https://www.revenueable.ai",
"https://example.com"
],
"language": "en-US",
"form_fields": [
{
"key": "company_name",
"value": "Revenueable AI"
},
{
"key": "product",
"value": "AI calling platform"
}
],
"voice": {
"id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
"name": "Sarah",
"voice_preview": "https://example.com/voice-preview.mp3"
},
"agent_config": {
"custom_variables": {
"callee_name": "string",
"mobile_number": "string"
},
"agent_prompt": "You are a helpful sales assistant.",
"intro_message": "Hello! I'm calling from Revenueable AI."
},
"knowledge_base_id": "7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d",
"knowledge_base_name": "Product FAQ",
"template_name": "sales",
"template_label": "Sales Agent",
"template_icon": "💼",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"updated_at": "2024-12-16T14:15:32.123456+00:00",
"tools": [],
"secondary_language": "hi-IN",
"secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
"template_type": "outbound"
}
}Headers
(Required) Your Revenueable AI API key.
Example:
"7251cb4b-3373-43a4-844c-b27a1d45e0c9"
Path Parameters
(Required) ID of the assistant to retrieve.
Example:
"830f767a-397e-4b39-82ff-235cd344e2f9"
Response
Successful Response: Detailed information about the assistant.
Show child attributes
Show child attributes
Previous
Edit AssistantUpdates an existing assistant with new configuration settings. Each operation requires specific fields to be provided.
Next
⌘I
Get Assistant By ID
curl --request GET \
--url https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id} \
--header 'X-API-KEY: <x-api-key>'import requests
url = "https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}"
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}', 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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}",
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}"
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://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}")
.header("X-API-KEY", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.revenueable.ai/ca/api/v0/agent/{agent_id}")
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{
"agents": {
"id": "830f767a-397e-4b39-82ff-235cd344e2f9",
"agent_display_name": "Sales Assistant",
"agent_type": "outbound",
"whitelisted_domains": [
"https://www.revenueable.ai",
"https://example.com"
],
"language": "en-US",
"form_fields": [
{
"key": "company_name",
"value": "Revenueable AI"
},
{
"key": "product",
"value": "AI calling platform"
}
],
"voice": {
"id": "3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d",
"name": "Sarah",
"voice_preview": "https://example.com/voice-preview.mp3"
},
"agent_config": {
"custom_variables": {
"callee_name": "string",
"mobile_number": "string"
},
"agent_prompt": "You are a helpful sales assistant.",
"intro_message": "Hello! I'm calling from Revenueable AI."
},
"knowledge_base_id": "7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d",
"knowledge_base_name": "Product FAQ",
"template_name": "sales",
"template_label": "Sales Agent",
"template_icon": "💼",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"updated_at": "2024-12-16T14:15:32.123456+00:00",
"tools": [],
"secondary_language": "hi-IN",
"secondary_voice_id": "4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e",
"template_type": "outbound"
}
}