Add a document to a knowledge base | Voicebip

Registers a document. For file sources (pdf/docx/txt) the response carries a short-lived presigned PUT URL the client uploads to, then calls the complete endpoint. For url sources, ingestion starts immediately.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

kb_idstringRequired

Request

This endpoint expects an object.

namestringRequired

source_typeenumRequired

Allowed values:

source_urlstringOptional

Required when source_type is url.

size_byteslongOptional

Exact file size in bytes. REQUIRED (> 0) for file sources (pdf/docx/txt); omit for url. Bound into the presigned PUT’s Content-Length, so the upload must send exactly this many bytes or S3 rejects it. Omitting it for a file source returns 400. (Expressed as prose, not a JSON-Schema if/then conditional, because the contract validator — kin-openapi — rejects 3.1 if/then siblings.)

Exact file size in bytes. REQUIRED (> 0) for file sources (pdf/docx/txt); omit for url. Bound into the presigned PUT's Content-Length, so the upload must send exactly this many bytes or S3 rejects it. Omitting it for a file source returns 400. (Expressed as prose, not a JSON-Schema if/then conditional, because the contract validator — kin-openapi — rejects 3.1 if/then siblings.)

Response

Document registered

chunk_countinteger

created_atdatetime

error_messagestring

idstring

knowledge_base_idstring

namestring

size_byteslong

source_typeenum

source_urlstring

statusenum

updated_atdatetime

upload_urlstring

Presigned PUT URL for file sources; empty for url sources.

Errors

400

Create Knowledge Base Document Request Bad Request Error

404

Create Knowledge Base Document Request Not Found Error

503

Create Knowledge Base Document Request Service Unavailable Error

$	curl -X POST https://api.voicebip.com/v1/knowledge-bases/kb_id/documents \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "name",
>	"source_type": "pdf"
>	}'

1	{
2	"chunk_count": 1,
3	"created_at": "2024-01-15T09:30:00Z",
4	"error_message": "error_message",
5	"id": "id",
6	"knowledge_base_id": "knowledge_base_id",
7	"name": "name",
8	"size_bytes": 1000000,
9	"source_type": "pdf",
10	"source_url": "source_url",
11	"status": "pending",
12	"updated_at": "2024-01-15T09:30:00Z",
13	"upload_url": "upload_url"
14	}