Create a cloud drive source

curl --request POST \
  --url https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support knowledge",
  "provider": "googledrive",
  "connection_id": "conn1b2c-0000-4000-8000-000000000090",
  "folder_id": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
  "folder_name": "Support docs",
  "include_subfolders": true,
  "max_files": 100,
  "auto_sync": true,
  "sync_interval_hours": 24
}
'

import requests

url = "https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources"

payload = {
    "name": "Support knowledge",
    "provider": "googledrive",
    "connection_id": "conn1b2c-0000-4000-8000-000000000090",
    "folder_id": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
    "folder_name": "Support docs",
    "include_subfolders": True,
    "max_files": 100,
    "auto_sync": True,
    "sync_interval_hours": 24
}
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({
    name: 'Support knowledge',
    provider: 'googledrive',
    connection_id: 'conn1b2c-0000-4000-8000-000000000090',
    folder_id: '1AbCdEfGhIjKlMnOpQrStUvWxYz',
    folder_name: 'Support docs',
    include_subfolders: true,
    max_files: 100,
    auto_sync: true,
    sync_interval_hours: 24
  })
};

fetch('https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources', 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}/drive-sources",
  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([
    'name' => 'Support knowledge',
    'provider' => 'googledrive',
    'connection_id' => 'conn1b2c-0000-4000-8000-000000000090',
    'folder_id' => '1AbCdEfGhIjKlMnOpQrStUvWxYz',
    'folder_name' => 'Support docs',
    'include_subfolders' => true,
    'max_files' => 100,
    'auto_sync' => true,
    'sync_interval_hours' => 24
  ]),
  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}/drive-sources"

	payload := strings.NewReader("{\n  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\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}/drive-sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources")

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  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "source": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Support knowledge",
      "provider": "googledrive",
      "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folder_id": "<string>",
      "folder_name": "<string>",
      "drive_id": "<string>",
      "include_subfolders": true,
      "max_files": 50,
      "auto_sync": true,
      "sync_interval_hours": 24,
      "status": "idle",
      "last_error": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "files_synced": 123,
      "credits_spent": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Knowledge Bases

Create a cloud drive source

Register a Google Drive, OneDrive, Box, Dropbox, or SharePoint folder as a sync source for a knowledge base, using an existing app connection (Automations → Connections). You can provide an optional custom name; when omitted, the remote folder name or ID becomes the initial display name and can be edited later. The sync lists files under folder_id (optionally recursive), indexes them as documents and charges credits per new/changed file. Trigger a sync with POST /knowledge-bases/{id}/drive-sources/{sourceId}/run, or enable auto_sync for periodic re-syncs. Required scope: knowledge:write (keys without scope restrictions have full access).

POST

knowledge-bases

{id}

drive-sources

Create a cloud drive source

curl --request POST \
  --url https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Support knowledge",
  "provider": "googledrive",
  "connection_id": "conn1b2c-0000-4000-8000-000000000090",
  "folder_id": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
  "folder_name": "Support docs",
  "include_subfolders": true,
  "max_files": 100,
  "auto_sync": true,
  "sync_interval_hours": 24
}
'

import requests

url = "https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources"

payload = {
    "name": "Support knowledge",
    "provider": "googledrive",
    "connection_id": "conn1b2c-0000-4000-8000-000000000090",
    "folder_id": "1AbCdEfGhIjKlMnOpQrStUvWxYz",
    "folder_name": "Support docs",
    "include_subfolders": True,
    "max_files": 100,
    "auto_sync": True,
    "sync_interval_hours": 24
}
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({
    name: 'Support knowledge',
    provider: 'googledrive',
    connection_id: 'conn1b2c-0000-4000-8000-000000000090',
    folder_id: '1AbCdEfGhIjKlMnOpQrStUvWxYz',
    folder_name: 'Support docs',
    include_subfolders: true,
    max_files: 100,
    auto_sync: true,
    sync_interval_hours: 24
  })
};

fetch('https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources', 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}/drive-sources",
  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([
    'name' => 'Support knowledge',
    'provider' => 'googledrive',
    'connection_id' => 'conn1b2c-0000-4000-8000-000000000090',
    'folder_id' => '1AbCdEfGhIjKlMnOpQrStUvWxYz',
    'folder_name' => 'Support docs',
    'include_subfolders' => true,
    'max_files' => 100,
    'auto_sync' => true,
    'sync_interval_hours' => 24
  ]),
  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}/drive-sources"

	payload := strings.NewReader("{\n  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\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}/drive-sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.famulor.io/api/v1/knowledge-bases/{id}/drive-sources")

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  \"name\": \"Support knowledge\",\n  \"provider\": \"googledrive\",\n  \"connection_id\": \"conn1b2c-0000-4000-8000-000000000090\",\n  \"folder_id\": \"1AbCdEfGhIjKlMnOpQrStUvWxYz\",\n  \"folder_name\": \"Support docs\",\n  \"include_subfolders\": true,\n  \"max_files\": 100,\n  \"auto_sync\": true,\n  \"sync_interval_hours\": 24\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "source": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Support knowledge",
      "provider": "googledrive",
      "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folder_id": "<string>",
      "folder_name": "<string>",
      "drive_id": "<string>",
      "include_subfolders": true,
      "max_files": 50,
      "auto_sync": true,
      "sync_interval_hours": 24,
      "status": "idle",
      "last_error": "<string>",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "files_synced": 123,
      "credits_spent": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization

string

header

required

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, 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

string<uuid>

required

Knowledge base ID.

Body

application/json

provider

enum<string>

required

Cloud drive provider.

Available options:

googledrive,

one_drive,

box,

dropbox,

sharepoint_graph

connection_id

string<uuid>

required

App connection ID — a connection under Automations → Connections whose toolkit matches provider.

folder_id

string

required

Remote folder ID to sync.

name

string

Optional custom display name shown for this source. If omitted, folder_name or folder_id is used initially and can be edited later.

Required string length: 1 - 128

Example:

"Support knowledge"

folder_name

string

Optional remote folder name captured from the connected drive. This is provider metadata, not the editable source name.

drive_id

string

Document library drive ID. REQUIRED for provider "sharepoint_graph"; optional for "one_drive" (SharePoint/Business drives accessed via the OneDrive toolkit); unused otherwise.

include_subfolders

boolean

Recurse into subfolders. Default true.

max_files

integer

Maximum files per run. Default 50.

Required range: 1 <= x <= 500

auto_sync

boolean

Re-sync automatically on a schedule. Default false.

sync_interval_hours

integer

Hours between auto-sync runs. Default 24.

Required range: x >= 1

Response

The created cloud drive source.

data

object

required

Show child attributes