curl --request PUT \
--url https://app.famulor.io/api/v1/dashboards/{id}/natural-language \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"compare_previous_period": true,
"filters": [
{
"operator": "<string>",
"value": "<string>"
}
],
"widgets": [
{
"title": "<string>"
}
]
}
}
'import requests
url = "https://app.famulor.io/api/v1/dashboards/{id}/natural-language"
payload = { "plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"compare_previous_period": True,
"filters": [
{
"operator": "<string>",
"value": "<string>"
}
],
"widgets": [{ "title": "<string>" }]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan: {
version: '<string>',
mode: '<string>',
prompt: '<string>',
compare_previous_period: true,
filters: [{operator: '<string>', value: '<string>'}],
widgets: [{title: '<string>'}]
}
})
};
fetch('https://app.famulor.io/api/v1/dashboards/{id}/natural-language', 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/dashboards/{id}/natural-language",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'plan' => [
'version' => '<string>',
'mode' => '<string>',
'prompt' => '<string>',
'compare_previous_period' => true,
'filters' => [
[
'operator' => '<string>',
'value' => '<string>'
]
],
'widgets' => [
[
'title' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/dashboards/{id}/natural-language"
payload := strings.NewReader("{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.famulor.io/api/v1/dashboards/{id}/natural-language")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/dashboards/{id}/natural-language")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"interpretation": "<string>",
"compare_previous_period": true,
"filters": [
{
"operator": "<string>",
"value": "<string>",
"label": "<string>"
}
],
"widgets": [
{
"title": "<string>",
"description": "<string>"
}
],
"warnings": [
"<string>"
]
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metric": "<string>",
"title": "<string>",
"group_by": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"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"
}
}Save a natural-language dashboard plan
Revalidates a previewed semantic plan and saves it as regular reusable dashboard widgets. Client-provided metric, filter, grouping, and visualization values are checked against the same server catalog again before any write. Required scope: dashboards:write or calls:write.
curl --request PUT \
--url https://app.famulor.io/api/v1/dashboards/{id}/natural-language \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"compare_previous_period": true,
"filters": [
{
"operator": "<string>",
"value": "<string>"
}
],
"widgets": [
{
"title": "<string>"
}
]
}
}
'import requests
url = "https://app.famulor.io/api/v1/dashboards/{id}/natural-language"
payload = { "plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"compare_previous_period": True,
"filters": [
{
"operator": "<string>",
"value": "<string>"
}
],
"widgets": [{ "title": "<string>" }]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plan: {
version: '<string>',
mode: '<string>',
prompt: '<string>',
compare_previous_period: true,
filters: [{operator: '<string>', value: '<string>'}],
widgets: [{title: '<string>'}]
}
})
};
fetch('https://app.famulor.io/api/v1/dashboards/{id}/natural-language', 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/dashboards/{id}/natural-language",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'plan' => [
'version' => '<string>',
'mode' => '<string>',
'prompt' => '<string>',
'compare_previous_period' => true,
'filters' => [
[
'operator' => '<string>',
'value' => '<string>'
]
],
'widgets' => [
[
'title' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/dashboards/{id}/natural-language"
payload := strings.NewReader("{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://app.famulor.io/api/v1/dashboards/{id}/natural-language")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/dashboards/{id}/natural-language")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plan\": {\n \"version\": \"<string>\",\n \"mode\": \"<string>\",\n \"prompt\": \"<string>\",\n \"compare_previous_period\": true,\n \"filters\": [\n {\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"widgets\": [\n {\n \"title\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"plan": {
"version": "<string>",
"mode": "<string>",
"prompt": "<string>",
"interpretation": "<string>",
"compare_previous_period": true,
"filters": [
{
"operator": "<string>",
"value": "<string>",
"label": "<string>"
}
],
"widgets": [
{
"title": "<string>",
"description": "<string>"
}
],
"warnings": [
"<string>"
]
},
"widgets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metric": "<string>",
"title": "<string>",
"group_by": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"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
Dashboard ID.
Body
Versioned, tenant-safe dashboard plan built exclusively from the semantic analytics catalog.
Show child attributes
Show child attributes
Response
Canonical plan and saved widgets.
Show child attributes
Show child attributes