Skip to main content
POST

Authorizations

Authorization
string
header
required

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

id
string<uuid>
required

Knowledge base ID.

Body

application/json

Provide exactly one of content (raw text) or url (file URL — PDF/DOCX/TXT/MD/CSV/HTML, downloaded server-side, max 20 MB). Processing (chunking + embeddings) runs synchronously.

name
string

Document name. Required for content sources; defaults to the file name for url sources.

content
string

Raw text content.

url
string

Public file URL to ingest.

description
string | null

Response

The processed document.

data
object
required