curl --request GET \
--url https://app.famulor.io/api/v1/prompt-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/prompt-templates"
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/prompt-templates', 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/prompt-templates",
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/prompt-templates"
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/prompt-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/prompt-templates")
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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content": "<string>",
"blueprint": {
"schema_version": 1,
"use_case": "<string>",
"outcome": "<string>",
"complexity": "starter",
"surfaces": [
"phone_inbound"
],
"requirements": [
{
"kind": "plan",
"label": "<string>",
"required": true,
"capability": "<string>"
}
],
"setup_steps": [
{
"id": "<string>",
"label": "<string>",
"required": true,
"href": "<string>"
}
],
"presentation": {
"mode": "visualizer",
"avatar_layout": "avatar"
},
"suggested_keyterms": [
"<string>"
]
},
"compatibility": {
"valid": true,
"node_count": 1,
"branch_count": 1,
"collected_fields": [
"<string>"
],
"surfaces": [
"phone_inbound"
],
"avatar_ready": true,
"setup_required": 1
},
"languages": [
"<string>"
],
"themes": [
"<string>"
],
"branches": [
"<string>"
],
"source": "platform",
"description": "<string>",
"first_message": "<string>",
"flow_json": {},
"category": "<string>",
"sort_order": 123,
"avatar_url": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}List prompt templates
System-prompt and conversational-flow templates visible to this workspace: platform templates (respecting global vs root visibility) plus workspace/reseller templates. Use an item’s id as template_id when creating an assistant for server-side resolution. blueprint describes the use-case outcome, supported surfaces, setup requirements and presentation. compatibility summarizes the validated flow graph. avatar_url is only the catalog portrait; avatar-ready blueprint presentation means the assistant is designed for a separately configured virtual speaking avatar. Required scope: assistants:read.
curl --request GET \
--url https://app.famulor.io/api/v1/prompt-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/prompt-templates"
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/prompt-templates', 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/prompt-templates",
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/prompt-templates"
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/prompt-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/prompt-templates")
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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"content": "<string>",
"blueprint": {
"schema_version": 1,
"use_case": "<string>",
"outcome": "<string>",
"complexity": "starter",
"surfaces": [
"phone_inbound"
],
"requirements": [
{
"kind": "plan",
"label": "<string>",
"required": true,
"capability": "<string>"
}
],
"setup_steps": [
{
"id": "<string>",
"label": "<string>",
"required": true,
"href": "<string>"
}
],
"presentation": {
"mode": "visualizer",
"avatar_layout": "avatar"
},
"suggested_keyterms": [
"<string>"
]
},
"compatibility": {
"valid": true,
"node_count": 1,
"branch_count": 1,
"collected_fields": [
"<string>"
],
"surfaces": [
"phone_inbound"
],
"avatar_ready": true,
"setup_required": 1
},
"languages": [
"<string>"
],
"themes": [
"<string>"
],
"branches": [
"<string>"
],
"source": "platform",
"description": "<string>",
"first_message": "<string>",
"flow_json": {},
"category": "<string>",
"sort_order": 123,
"avatar_url": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.
Query Parameters
ISO-639-1 language filter (e.g. de).
Use-case theme. Built-in themes: receptionist, lead_qualifier, appointment, support, screener, survey, sales, personal_assistant, callback_intake, property_lead, service_intake, feedback_survey, guest_concierge, avatar_concierge, loop_recall. Templates can also carry custom themes, which filter the same way.
Industry branch: general, healthcare, dental, real_estate, home_services, saas, hospitality, legal, automotive, ecommerce, education.
Search name, description, and content.
When true, only templates with a Flow JSON graph. When false, only Single-prompt templates (flow_json null).
Response
Visible prompt templates.
Show child attributes
Show child attributes