Get Agent
curl --request GET \
--url 'https://api.vida.dev/api/v2/agent/{agentId}?token='import requests
url = "https://api.vida.dev/api/v2/agent/{agentId}?token="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vida.dev/api/v2/agent/{agentId}?token=', 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.vida.dev/api/v2/agent/{agentId}?token=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.vida.dev/api/v2/agent/{agentId}?token="
req, _ := http.NewRequest("GET", url, nil)
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.vida.dev/api/v2/agent/{agentId}?token=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/agent/{agentId}?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Success",
"campaign": {
"id": "campa931829b5857f....",
"title": "Front Desk Operator",
"campaignType": "chatAgent",
"enabled": true,
"published": true,
"welcomeMessage": "Hello, thanks for calling. How can I help you today?",
"timezone": "America/Chicago",
"agentVoice": "cedar",
"agentLang": "multi",
"agentModel": "gpt-5.4",
"agentThinking": null,
"agentInstructions": "Answer as the front desk operator and book appointments when appropriate.",
"publicInstructions": "Keep public-channel replies concise and ask clarifying questions one at a time.",
"adminInstructions": "Report missed-call spikes and urgent customer escalations to your boss.",
"heartbeatInstructions": "Check for overdue callbacks on every heartbeat.",
"heartbeatEvery": "15m",
"links": [
"https://vida.io/faq"
],
"activeEventRules": [
"default"
],
"actions": [
{
"name": "transfer",
"instructions": "Transfer important calls directly to the owner.",
"placeholder": "When should your agent route calls and conversations to you?",
"allowed": true
}
],
"skills": [
{
"slug": "google-drive",
"instructions": "Use this for customer spreadsheet review.",
"allowed": true,
"usable": false,
"reason": "not_installed"
}
],
"apps": [
{}
],
"lastUpdate": 1776634844766
}
}Agents
Get Agent
Fetch an agent details
GET
/
api
/
v2
/
agent
/
{agentId}
Get Agent
curl --request GET \
--url 'https://api.vida.dev/api/v2/agent/{agentId}?token='import requests
url = "https://api.vida.dev/api/v2/agent/{agentId}?token="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vida.dev/api/v2/agent/{agentId}?token=', 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.vida.dev/api/v2/agent/{agentId}?token=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.vida.dev/api/v2/agent/{agentId}?token="
req, _ := http.NewRequest("GET", url, nil)
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.vida.dev/api/v2/agent/{agentId}?token=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/agent/{agentId}?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Success",
"campaign": {
"id": "campa931829b5857f....",
"title": "Front Desk Operator",
"campaignType": "chatAgent",
"enabled": true,
"published": true,
"welcomeMessage": "Hello, thanks for calling. How can I help you today?",
"timezone": "America/Chicago",
"agentVoice": "cedar",
"agentLang": "multi",
"agentModel": "gpt-5.4",
"agentThinking": null,
"agentInstructions": "Answer as the front desk operator and book appointments when appropriate.",
"publicInstructions": "Keep public-channel replies concise and ask clarifying questions one at a time.",
"adminInstructions": "Report missed-call spikes and urgent customer escalations to your boss.",
"heartbeatInstructions": "Check for overdue callbacks on every heartbeat.",
"heartbeatEvery": "15m",
"links": [
"https://vida.io/faq"
],
"activeEventRules": [
"default"
],
"actions": [
{
"name": "transfer",
"instructions": "Transfer important calls directly to the owner.",
"placeholder": "When should your agent route calls and conversations to you?",
"allowed": true
}
],
"skills": [
{
"slug": "google-drive",
"instructions": "Use this for customer spreadsheet review.",
"allowed": true,
"usable": false,
"reason": "not_installed"
}
],
"apps": [
{}
],
"lastUpdate": 1776634844766
}
}Authorizations
Vida API Token
Path Parameters
Agent Id
⌘I