Skip to main content
GET
Retrieve a knowledge base file

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

fileId
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Response

The file

A file in a knowledge base. A document’s text is read and split into passages; an agent using the knowledge base searches them during a call with the built-in search_knowledge tool. An image or video is found by its description. The original is kept so agents can send it on WhatsApp.

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
knowledge_file
knowledge_base_id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

name
string
required
kind
enum<string>
required

image and video are for agents to send on WhatsApp; they are found by their description.

Available options:
pdf,
docx,
txt,
md,
csv,
html,
image,
video
bytes
integer
required
pages
integer | null
required
chars
integer
required

Characters of text read from it.

chunks
integer
required

Passages the agent can search.

status
enum<string>
required

processing while it is read (usually seconds); ready once agents can search it; failed with error saying why.

Available options:
processing,
ready,
failed
error
string | null
required

Why it failed, or a note on a ready file (such as only part of it being kept).

source_url
string | null
required
description
string
required

What the file is or shows. Required for images and videos.

mime_type
string | null
required
sendable
boolean
required

Whether agents can send it on WhatsApp: its original was kept. Files added before WhatsApp sending was available are not.

created_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"