curl --request POST \
--url https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"values": {},
"mode": "dry_run",
"confirm_write": false
}
'import requests
url = "https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test"
payload = {
"values": {},
"mode": "dry_run",
"confirm_write": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({values: {}, mode: 'dry_run', confirm_write: false})
};
fetch('https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test', 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/tools/app-actions/{toolId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'values' => [
],
'mode' => 'dry_run',
'confirm_write' => false
]),
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/tools/app-actions/{toolId}/test"
payload := strings.NewReader("{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"envelope": {
"ok": true,
"app": "<string>",
"action": "<string>",
"result": "<unknown>",
"truncated": true,
"outcome": "confirmation_required",
"summary": "<string>",
"read_back": {},
"code": "invalid_input",
"retryable": true,
"error": "<string>"
},
"model_text": "<string>",
"arguments_preview": {},
"duration_ms": 123,
"dry_run": true,
"read_back": {}
}
}Test an app action tool
Run the tool with sample values and return the exact text the assistant would receive. Actions that only read data always run. For an action that changes data the default is a dry run: the values are mapped, but nothing is sent to the app, and read_back shows what the assistant would read back. mode: live with confirm_write: true runs it and changes real data in the app. Requires an owner or admin credential and a plan with Automations. Requires both assistants:write and automations:write.
curl --request POST \
--url https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"values": {},
"mode": "dry_run",
"confirm_write": false
}
'import requests
url = "https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test"
payload = {
"values": {},
"mode": "dry_run",
"confirm_write": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({values: {}, mode: 'dry_run', confirm_write: false})
};
fetch('https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test', 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/tools/app-actions/{toolId}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'values' => [
],
'mode' => 'dry_run',
'confirm_write' => false
]),
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/tools/app-actions/{toolId}/test"
payload := strings.NewReader("{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/tools/app-actions/{toolId}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"values\": {},\n \"mode\": \"dry_run\",\n \"confirm_write\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"envelope": {
"ok": true,
"app": "<string>",
"action": "<string>",
"result": "<unknown>",
"truncated": true,
"outcome": "confirmation_required",
"summary": "<string>",
"read_back": {},
"code": "invalid_input",
"retryable": true,
"error": "<string>"
},
"model_text": "<string>",
"arguments_preview": {},
"duration_ms": 123,
"dry_run": true,
"read_back": {}
}
}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.