POST

Add URL Source

Adds a web page as a source by crawling and indexing its content.

POSThttps://api.vantaxai.com/v1/knowledge-bases/{knowledgebase_id}/sources/url

The page at the supplied `url` is fetched, cleaned, chunked, and embedded. The source begins in the `processing` state while the crawl runs and becomes `ready` once indexing completes.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

knowledgebase_idstringrequired
The knowledge base to add the source to.
example: kb_71ac0

Body Parameters

urlstringrequired
The fully-qualified URL to crawl.
example: https://example.com/pricing
titlestringoptional
Optional label. Defaults to the page title.

Request

curl -X POST https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0/sources/url \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/pricing",
  "title": "string"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0/sources/url",
  {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/pricing",
    "title": "string"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/knowledge-bases/{knowledgebase_id}/sources/url
const result = await vantax.request("POST", "/v1/knowledge-bases/{knowledgebase_id}/sources/url", {
  "url": "https://example.com/pricing",
  "title": "string"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/knowledge-bases/{knowledgebase_id}/sources/url
result = vantax.request("POST", "/v1/knowledge-bases/{knowledgebase_id}/sources/url", json={"url": "https://example.com/pricing", "title": "string"})

Response

{
  "success": true,
  "message": "Source added successfully",
  "data": {
    "id": "doc_2f7d04",
    "knowledgebase_id": "kb_71ac0",
    "type": "url",
    "title": "Pricing — Example Clinic",
    "status": "processing",
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "url", "message": "url must be a valid URL" }
  ]
}