Get an agent

curl --request GET \
  --url https://api.vocily.ai/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.vocily.ai/v1/agents/{agent_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vocily.ai/v1/agents/{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://api.vocily.ai/v1/agents/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.vocily.ai/v1/agents/{agent_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.vocily.ai/v1/agents/{agent_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocily.ai/v1/agents/{agent_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "00000005-0000-4000-8000-000000000005",
  "name": "Support line",
  "version": 0,
  "version_id": "00000006-0000-4000-8000-000000000006",
  "is_published": false,
  "is_live": false,
  "live_version": null,
  "latest_version": 0,
  "document_revision": 1,
  "label": null,
  "notes": null,
  "blocked_reasons": [],
  "created_at": "2026-09-16T19:38:03.767024Z",
  "updated_at": "2026-09-16T19:38:03.767024Z",
  "system_prompt": "## Agent Purpose\nYou confirm cash-on-delivery orders for Acme Store.\n\n## Response Style\nWarm, brief, one question at a time.\n\n## Call Flow\n1. Greet {{callee_name}}.\n2. Read back order {{order_id}}.\n3. Ask whether they accept delivery.\n4. Close politely.",
  "greeting": {
    "message": "Hello! I am your AI voice agent. How can I help you today?",
    "prompt": "The voice call has connected and the caller has not spoken. Generate the opening greeting using the agent identity, purpose, response style, call flow and any prepared call information in the system instructions. Follow the configured primary language. Keep it to one or two short spoken sentences and at most one question. Do not invent caller details or completed actions. Do not output placeholders, tool calls, stage directions or an explanation. Return only the words to speak.",
    "mode": "custom",
    "delay_ms": 0
  },
  "language": {
    "default": "hi-IN",
    "additional": [
      "en-IN"
    ],
    "switch_trigger": "requested_or_auto"
  },
  "transcriber": {
    "provider": "sarvam",
    "model": "saaras:v4",
    "keywords": [
      "Acme",
      "COD"
    ],
    "fallback": {
      "provider": "deepgram",
      "model": "nova-3-general"
    }
  },
  "model": {
    "provider": "openai",
    "model": "gpt-5.4-nano",
    "temperature": 0.4,
    "max_tokens": 128,
    "fallback": {
      "provider": "gemini",
      "model": "gemini-3.5-flash-lite"
    }
  },
  "voice": {
    "provider": "vocily",
    "model": "v2",
    "voice_id": "hi-IN-aman",
    "speed": 1,
    "emotion": null,
    "fallback": {
      "provider": "sarvam",
      "model": "bulbul:v3",
      "voice_id": "shubh"
    }
  },
  "conversation": {
    "interruption_sensitivity": 0.5,
    "response_eagerness": 0.75,
    "noise_handling": {
      "mode": "standard",
      "level": 50
    },
    "silence_reminder": {
      "enabled": true,
      "seconds": 15
    }
  },
  "call": {
    "max_duration_minutes": 5,
    "end_on_silence_seconds": 25,
    "recording_enabled": true,
    "custom_analysis_enabled": true,
    "max_duration_message": {
      "mode": "default",
      "prompt": "The call has reached its maximum allowed duration and must end now. Generate a brief, natural closing in the same language and tone as the conversation above. The message must clearly preserve this intent: the maximum call time has been reached, so the call is ending now. Keep it to one short sentence, with an optional brief thank-you. Do not ask a question. Do not offer more help, a callback, next steps, or reopen the conversation.",
      "text": ""
    },
    "end_on_silence_message": {
      "mode": "default",
      "prompt": "The caller has been silent for too long and the call is ending now. Generate a brief, natural closing in the same language and tone as the conversation above. The message must clearly preserve this intent: you could not hear anything on the line, so you are ending the call now. Keep it to one short sentence, with an optional brief thank-you. Do not ask a question. Do not offer more help, a callback, next steps, or reopen the conversation.",
      "text": ""
    }
  },
  "builtin_tools": {
    "end_call": {
      "enabled": true
    },
    "hold_call": {
      "enabled": true,
      "max_seconds": 90,
      "follow_up_seconds": 45,
      "acknowledgement_message": {
        "mode": "default",
        "prompt": "Write one short sentence to say to the caller as you start waiting, in the language you have been speaking — confirming you heard them and will wait. Do not ask a question and do not guess why they need the moment.",
        "text": ""
      },
      "follow_up_message": {
        "mode": "default",
        "prompt": "You agreed to wait while the caller stepped away for a moment (they may be fetching a card, a document, or checking something). Generate one very short, gentle check-in in the same language and tone as the conversation above. Keep it to one short sentence, e.g. asking if they are back or reassuring them you are still on the line. Do not say goodbye. Do not say the call is ending. Do not repeat earlier content or ask new questions.",
        "text": ""
      },
      "timeout_message": {
        "mode": "default",
        "prompt": "You agreed to wait while the caller stepped away, but they have not returned and the call is ending now. Generate a brief, natural closing in the same language and tone as the conversation above. The message must clearly preserve this intent: you waited but could not reach them, so you are ending the call; they are welcome to call back. Keep it to one short sentence. Do not ask a question.",
        "text": ""
      }
    },
    "transfer_call": {
      "enabled": true,
      "numbers": [
        {
          "number": "+919876543210",
          "priority": 1,
          "start_hour": 9,
          "end_hour": 20,
          "timezone": "Asia/Kolkata",
          "max_concurrent_calls": 1
        }
      ],
      "busy_message": {
        "mode": "default",
        "prompt": "You tried to transfer the caller to a human teammate, but nobody is available. Generate one short line in the same language and tone as the conversation above, saying the team is busy right now and asking them to try again a little later. Do not ask a question and do not promise a callback.",
        "text": ""
      },
      "intro_message": {
        "mode": "custom",
        "prompt": "You are about to transfer the caller to a human teammate. Generate one short line in the same language and tone as the conversation above, telling them to hold while you connect them. Do not ask a question and do not promise a specific person, a wait time or a callback.",
        "text": "Ek minute, main aapko connect karti hoon."
      }
    },
    "send_whatsapp_template": {
      "enabled": false,
      "templates": []
    }
  },
  "variables": [
    {
      "key": "callee_name",
      "default_value": null,
      "system_defined": true,
      "deletable": false
    },
    {
      "key": "callee_number",
      "default_value": null,
      "system_defined": true,
      "deletable": false
    }
  ],
  "knowledge_base_ids": [],
  "analysis_group_ids": [
    "00000007-0000-4000-8000-000000000007"
  ],
  "memory": {
    "enabled": true,
    "channels": [
      "outbound",
      "whatsapp"
    ],
    "allow_ai_labels": true,
    "label_instructions": "Record anything about the caller worth knowing next time, even when it is not one of the fields above: who they are, other ways to reach them, how they prefer to be dealt with, their standing with the business, or anything situational. Only what will still be true later; nothing said in passing.",
    "max_facts": 150,
    "transcript_turns": 12,
    "fields": [
      {
        "key": "delivery_pincode",
        "label": "Delivery PIN code",
        "type": "string",
        "enum_values": null,
        "description": "The PIN code the caller wants deliveries sent to.",
        "category": "contact"
      }
    ]
  },
  "numbers": null,
  "dashboard_url": "https://app.vocily.ai/agents/00000005-0000-4000-8000-000000000005",
  "inbound": {
    "business_hours_closed_message": {
      "mode": "default",
      "prompt": "This inbound call arrived outside business hours. Generate one short line telling the caller we are closed right now and inviting them to call back during business hours. Keep it to one sentence. Do not ask a question and do not invent the opening hours.",
      "text": ""
    },
    "fallback_message": {
      "mode": "default",
      "prompt": "This inbound call cannot be handled right now. Generate one short, apologetic line asking the caller to try again later. Keep it to one sentence. Do not ask a question and do not explain the technical reason.",
      "text": ""
    }
  }
}

{
  "detail": "Invalid API key",
  "code": "UNAUTHORIZED"
}

{
  "detail": {
    "code": "validation_error",
    "message": "<string>",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "type": "<string>"
      }
    ]
  },
  "code": "VALIDATION_ERROR"
}

{
  "code": "rate_limited"
}