Knowledge base - OnDial API

Knowledge bases power agent answers during calls and messaging. You can manage documents via Public API v1 or the dashboard.

Public API (v1)

Requires scopes knowledge:read (list, metadata, billing preview) and knowledge:write (upload, delete). Request these when your API key is approved.

Action	Endpoint
List documents	`GET /api/v1/knowledge-bases/documents`
Upload	`POST /api/v1/knowledge-bases/documents` (multipart `file`)
Metadata	`GET /api/v1/knowledge-bases/documents/{fileId}`
Delete	`DELETE /api/v1/knowledge-bases/documents/{fileId}`
Billing preview	`GET /api/v1/knowledge-bases/upload-billing-info`

Supported file types: PDF, Word, Excel, TXT (max 50MB). Security: v1 returns metadata only - no file bytes and no download URL. Live keys may debit credits on upload when billing is enabled; sandbox keys skip debit.

Linking to agents

GET /api/v1/companies / GET /api/v1/knowledge-bases/documents to pick ids
POST or PATCH /api/v1/inbound-agents with companyId and selectedKnowledgebases: ["fileId", …]
Confirm on GET /api/v1/inbound-agents/{id} (companyId + selectedKnowledgebases in the response)

See Upload document and Healthcare HMS integration.