PATCH

Rename Source

Updates the display title of a source.

PATCHhttps://api.vantaxai.com/v1/sources/{source_id}

Renaming only changes the source's label; it does not re-index its content.

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

source_idstringrequired
The source to rename.
example: doc_4b2e91

Body Parameters

titlestringrequired
The new display title.
example: Cancellation & Refund Policy

Request

curl -X PATCH https://api.vantaxai.com/v1/sources/doc_4b2e91 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Cancellation & Refund Policy"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/sources/doc_4b2e91",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "Cancellation & Refund Policy"
  }),
  }
);
const { data } = await res.json();

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/sources/{source_id}
const result = await vantax.request("PATCH", "/v1/sources/{source_id}", {
  "title": "Cancellation & Refund Policy"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/sources/{source_id}
result = vantax.request("PATCH", "/v1/sources/{source_id}", json={"title": "Cancellation & Refund Policy"})

Response

{
  "success": true,
  "message": "Source updated successfully",
  "data": {
    "id": "doc_4b2e91",
    "knowledgebase_id": "kb_71ac0",
    "type": "text",
    "title": "Cancellation & Refund Policy",
    "status": "ready",
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{ "success": false, "message": "Source not found" }

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "title", "message": "title is required" }
  ]
}