Retrieve agent blueprints
curl --request GET \
--url https://api.subverseai.com/api/agent/blueprints \
--header 'x-api-key: <api-key>'import requests
url = "https://api.subverseai.com/api/agent/blueprints"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.subverseai.com/api/agent/blueprints', 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.subverseai.com/api/agent/blueprints",
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: <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://api.subverseai.com/api/agent/blueprints"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api.subverseai.com/api/agent/blueprints")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subverseai.com/api/agent/blueprints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"responseCode": 200,
"message": "Agent blueprints retrieved successfully!",
"data": {
"agents": [
{
"agentId": "customer_support_agent",
"config": {
"llmService": {
"provider": "openai",
"model": "gpt-4o-mini",
"temperature": 0.5
},
"sttService": {
"provider": "deepgram",
"model": "nova-2-general",
"language": "en-US",
"smartFormat": false,
"numerals": false,
"keywords": null
},
"ttsService": {
"provider": "elevenlabs",
"model": "eleven_flash_v2_5",
"language": "en-US",
"gender": "female",
"voiceName": "monika",
"customVoiceId": "",
"speed": 1,
"stability": 0.5,
"similarityBoost": 0.8,
"pitch": 1,
"volume": 1
},
"agentInstructions": {
"initialMessage": {
"messageContent": "Hello! I'm your virtual assistant. How can I help you today?",
"messageType": "say",
"firstSpeaker": "assistant"
},
"systemContext": [
{
"system": "You are a helpful customer service agent for a telecommunications company."
}
],
"conversationalFlow": {
"nodes": [
{
"id": "welcome",
"type": "message",
"data": {
"message": "Welcome!"
},
"position": {
"x": 0,
"y": 0
}
}
],
"edges": []
}
},
"callSettings": {
"dtmfEnabled": false,
"transferTo": "",
"transferDtmf": "",
"warmTransfer": false,
"sipRefer": false,
"backgroundAmbient": false,
"backgroundThinking": false,
"whisper": false,
"falseInterruptionTimer": 3,
"preemptiveGeneration": true
},
"pipelineSettings": {
"commMethod": "two_way",
"silenceTime": 8,
"silenceTurns": 2,
"knowledgeBaseId": "",
"maxDuration": 600
},
"turnManagement": {
"interruptionOverall": true,
"interruptionInitial": false,
"interruptionSensitivity": 2,
"agentResponsiveness": 4,
"agentBackchannel": {
"enabled": true,
"threshold": 0,
"fillerWords": [],
"probability": 1,
"interruptions": true,
"addToContext": false
}
},
"analyticsConfig": {
"enabled": true,
"provider": "openai",
"model": "gpt-4o-mini",
"instructions": null,
"queries": [
{
"name": "summary",
"description": "Summary of discussion",
"type": "text",
"options": []
}
]
},
"functionSettings": {
"preCall": [],
"duringCall": [
"end_call",
"transfer_call"
],
"postCall": []
},
"agentsList": [
{
"transferTo": "billing_agent",
"useBaseSettings": true,
"agentVersion": "DEFAULT"
}
],
"dynamicVariablesConfig": [
{
"name": "customer_name",
"description": "Customer's full name"
}
]
},
"version": {
"name": "v0",
"description": "First version",
"number": 0
}
}
],
"workflowList": [
{
"workflowId": "customer_support",
"agentId": "customer_support_agent"
}
]
}
}{
"responseCode": 401,
"message": "API key is missing",
"data": null
}{
"responseCode": 500,
"message": "Internal server error",
"data": null
}Agent
Agent Blueprints
Retrieves all available agent blueprints and their default version configurations along with workflow mappings. This endpoint provides comprehensive information about voice agents including their full configuration, version details, and which workflows they are associated with.
GET
/
agent
/
blueprints
Retrieve agent blueprints
curl --request GET \
--url https://api.subverseai.com/api/agent/blueprints \
--header 'x-api-key: <api-key>'import requests
url = "https://api.subverseai.com/api/agent/blueprints"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.subverseai.com/api/agent/blueprints', 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.subverseai.com/api/agent/blueprints",
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: <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://api.subverseai.com/api/agent/blueprints"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api.subverseai.com/api/agent/blueprints")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subverseai.com/api/agent/blueprints")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"responseCode": 200,
"message": "Agent blueprints retrieved successfully!",
"data": {
"agents": [
{
"agentId": "customer_support_agent",
"config": {
"llmService": {
"provider": "openai",
"model": "gpt-4o-mini",
"temperature": 0.5
},
"sttService": {
"provider": "deepgram",
"model": "nova-2-general",
"language": "en-US",
"smartFormat": false,
"numerals": false,
"keywords": null
},
"ttsService": {
"provider": "elevenlabs",
"model": "eleven_flash_v2_5",
"language": "en-US",
"gender": "female",
"voiceName": "monika",
"customVoiceId": "",
"speed": 1,
"stability": 0.5,
"similarityBoost": 0.8,
"pitch": 1,
"volume": 1
},
"agentInstructions": {
"initialMessage": {
"messageContent": "Hello! I'm your virtual assistant. How can I help you today?",
"messageType": "say",
"firstSpeaker": "assistant"
},
"systemContext": [
{
"system": "You are a helpful customer service agent for a telecommunications company."
}
],
"conversationalFlow": {
"nodes": [
{
"id": "welcome",
"type": "message",
"data": {
"message": "Welcome!"
},
"position": {
"x": 0,
"y": 0
}
}
],
"edges": []
}
},
"callSettings": {
"dtmfEnabled": false,
"transferTo": "",
"transferDtmf": "",
"warmTransfer": false,
"sipRefer": false,
"backgroundAmbient": false,
"backgroundThinking": false,
"whisper": false,
"falseInterruptionTimer": 3,
"preemptiveGeneration": true
},
"pipelineSettings": {
"commMethod": "two_way",
"silenceTime": 8,
"silenceTurns": 2,
"knowledgeBaseId": "",
"maxDuration": 600
},
"turnManagement": {
"interruptionOverall": true,
"interruptionInitial": false,
"interruptionSensitivity": 2,
"agentResponsiveness": 4,
"agentBackchannel": {
"enabled": true,
"threshold": 0,
"fillerWords": [],
"probability": 1,
"interruptions": true,
"addToContext": false
}
},
"analyticsConfig": {
"enabled": true,
"provider": "openai",
"model": "gpt-4o-mini",
"instructions": null,
"queries": [
{
"name": "summary",
"description": "Summary of discussion",
"type": "text",
"options": []
}
]
},
"functionSettings": {
"preCall": [],
"duringCall": [
"end_call",
"transfer_call"
],
"postCall": []
},
"agentsList": [
{
"transferTo": "billing_agent",
"useBaseSettings": true,
"agentVersion": "DEFAULT"
}
],
"dynamicVariablesConfig": [
{
"name": "customer_name",
"description": "Customer's full name"
}
]
},
"version": {
"name": "v0",
"description": "First version",
"number": 0
}
}
],
"workflowList": [
{
"workflowId": "customer_support",
"agentId": "customer_support_agent"
}
]
}
}{
"responseCode": 401,
"message": "API key is missing",
"data": null
}{
"responseCode": 500,
"message": "Internal server error",
"data": null
}Authorizations
Authentication header containing API key from SubVerse dashboard.
Response
Agent blueprints retrieved successfully
⌘I