curl --request GET \
--url https://app.famulor.io/api/v1/assistants/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/assistants/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/assistants/{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{
"data": {
"id": "a1b2c3d4-0000-4000-8000-000000000001",
"name": "Support Agent",
"is_active": true,
"created_by": "u1b2c3d4-0000-4000-8000-000000000003",
"system_prompt": "You are a friendly support agent for Acme Corp...",
"mode": "pipeline",
"realtime_provider": null,
"realtime_model": null,
"realtime_voice": null,
"llm_provider": null,
"llm_model": null,
"llm_temperature": 0.7,
"stt_provider": "deepgram",
"stt_model": "nova-3",
"stt_language": "en",
"tts_provider": "elevenlabs",
"tts_model": "eleven_turbo_v2_5",
"tts_voice": "21m00Tcm4TlvDq8ikWAM",
"tts_speed": 1,
"turn_detection": "multilingual_model",
"first_message": "Hi! How can I help you today?",
"greeting_mode": "agent_speaks_first",
"recording_enabled": true,
"max_call_duration_sec": 1200,
"inbound_ringing_timeout_sec": 60,
"outbound_ringing_timeout_sec": 45,
"idle_timeout_sec": 30,
"knowledgebase_id": null,
"webhook_url": null,
"metadata": {},
"created_at": "2026-07-01T09:00:00Z",
"updated_at": "2026-07-01T09:00:00Z"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}Get an assistant
Required scope: assistants:read (keys without scope restrictions have full access).
curl --request GET \
--url https://app.famulor.io/api/v1/assistants/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/assistants/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{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://app.famulor.io/api/v1/assistants/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/assistants/{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{
"data": {
"id": "a1b2c3d4-0000-4000-8000-000000000001",
"name": "Support Agent",
"is_active": true,
"created_by": "u1b2c3d4-0000-4000-8000-000000000003",
"system_prompt": "You are a friendly support agent for Acme Corp...",
"mode": "pipeline",
"realtime_provider": null,
"realtime_model": null,
"realtime_voice": null,
"llm_provider": null,
"llm_model": null,
"llm_temperature": 0.7,
"stt_provider": "deepgram",
"stt_model": "nova-3",
"stt_language": "en",
"tts_provider": "elevenlabs",
"tts_model": "eleven_turbo_v2_5",
"tts_voice": "21m00Tcm4TlvDq8ikWAM",
"tts_speed": 1,
"turn_detection": "multilingual_model",
"first_message": "Hi! How can I help you today?",
"greeting_mode": "agent_speaks_first",
"recording_enabled": true,
"max_call_duration_sec": 1200,
"inbound_ringing_timeout_sec": 60,
"outbound_ringing_timeout_sec": 45,
"idle_timeout_sec": 30,
"knowledgebase_id": null,
"webhook_url": null,
"metadata": {},
"created_at": "2026-07-01T09:00:00Z",
"updated_at": "2026-07-01T09:00:00Z"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Path Parameters
Assistant ID.
Response
The assistant.
A voice assistant configuration. Nullable model overrides are independent per engine: pipeline uses llm_*, realtime uses realtime_*, and half-cascade uses half_cascade_* for its text-capable realtime input plus tts_* for output.
Show child attributes
Show child attributes