Knowledge bases

Add a web page

POSThttps://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/sources/url

Fetch one public web page (HTML, text or PDF, up to 5 MB) and index its text. Links are not followed. Addresses on private networks are refused.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.edit permission.

X-API-KeyAuthorization: Beareragents.edit

Path parameters

kb_idstringrequired

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

urlstringrequired

One page; links on it are not followed.

at most 2000 characters

namestring

Defaults to the page title.

at most 200 characters

Response

201Success.

idstring

kb_idstring

kindenum<string>

One of:fileurltext

namestring

urlstring

content_typestring

sizeintegerdefault: 0

statusenum<string>

One of:processingreadyfailed

errorstring

Why processing failed, when status is failed.

chunk_countintegerdefault: 0

charactersintegerdefault: 0

created_atstring

date-time

processed_atstring | null

date-time

created_bystring

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request POST \ --url 'https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/sources/url?timezone=Asia/Kolkata' \ --header 'X-API-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://example.com/hook", "name": "" }'

import requests url = "https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/sources/url" params = { "timezone": "Asia/Kolkata", } headers = { "X-API-Key": "<api-key>", } payload = { "url": "https://example.com/hook", "name": "", } response = requests.post(url, params=params, headers=headers, json=payload) print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/knowledge-bases/{kb_id}/sources/url?timezone=Asia/Kolkata", { method: "POST", headers: { "X-API-Key": "<api-key>", "Content-Type": "application/json", }, body: JSON.stringify({ "url": "https://example.com/hook", "name": "" }), }) const data = await response.json() console.log(response.status, data)

{ "id": "id", "kb_id": "kb", "kind": "file", "name": "Example", "url": "", "content_type": "", "size": 0, "status": "processing", "error": "", "chunk_count": 0, "characters": 0, "created_at": "2026-10-01T15:30:00+05:30", "processed_at": null, "created_by": "" }