curl --request POST \
--url https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"root_url": "https://example.com/docs",
"max_pages": 50
}
'import requests
url = "https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover"
payload = {
"root_url": "https://example.com/docs",
"max_pages": 50
}
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({root_url: 'https://example.com/docs', max_pages: 50})
};
fetch('https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover', 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/knowledge-bases/{id}/crawl-sources/discover",
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([
'root_url' => 'https://example.com/docs',
'max_pages' => 50
]),
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/knowledge-bases/{id}/crawl-sources/discover"
payload := strings.NewReader("{\n \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\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/knowledge-bases/{id}/crawl-sources/discover")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover")
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 \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\n}"
response = http.request(request)
puts response.read_body{
"data": {
"discovery": {
"root_url": "<string>",
"pages": [
{
"url": "<string>",
"path": "/docs/getting-started"
}
],
"include_paths": [
"<string>"
],
"exclude_paths": [
"<string>"
],
"robots_txt_found": true,
"sitemap_found": true,
"truncated": true
}
}
}Discover website crawl paths
Inspect a website before creating or updating a crawl source. The preview uses the same-host, SSRF, robots.txt and sitemap rules as the crawler, but creates no source or documents, performs no indexing and spends no credits. Required scope: knowledge:read (keys without scope restrictions have full access).
curl --request POST \
--url https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"root_url": "https://example.com/docs",
"max_pages": 50
}
'import requests
url = "https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover"
payload = {
"root_url": "https://example.com/docs",
"max_pages": 50
}
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({root_url: 'https://example.com/docs', max_pages: 50})
};
fetch('https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover', 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/knowledge-bases/{id}/crawl-sources/discover",
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([
'root_url' => 'https://example.com/docs',
'max_pages' => 50
]),
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/knowledge-bases/{id}/crawl-sources/discover"
payload := strings.NewReader("{\n \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\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/knowledge-bases/{id}/crawl-sources/discover")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/knowledge-bases/{id}/crawl-sources/discover")
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 \"root_url\": \"https://example.com/docs\",\n \"max_pages\": 50\n}"
response = http.request(request)
puts response.read_body{
"data": {
"discovery": {
"root_url": "<string>",
"pages": [
{
"url": "<string>",
"path": "/docs/getting-started"
}
],
"include_paths": [
"<string>"
],
"exclude_paths": [
"<string>"
],
"robots_txt_found": true,
"sitemap_found": true,
"truncated": true
}
}
}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.
Path Parameters
Knowledge base ID.
Body
Response
Crawlable page paths and editable include/exclude suggestions.
Show child attributes
Show child attributes