POST

Assign Knowledge Base to Agent

Attaches a knowledge base so the Agent can reference it.

POSThttps://api.vantaxai.com/v1/agents/{agent_id}/knowledge-bases

When attached, the Agent can answer questions using the documents, FAQs, and pages in the knowledge base during calls and conversations.

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

agent_idstringrequired
The Agent to attach the knowledge base to.
example: agt_3d9b21

Body Parameters

knowledgebase_idstringrequired
The knowledge base to attach.
example: kb_71ac0

Request

curl -X POST https://api.vantaxai.com/v1/agents/agt_3d9b21/knowledge-bases \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "knowledgebase_id": "kb_71ac0"
}'

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

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/agents/{agent_id}/knowledge-bases
const result = await vantax.request("POST", "/v1/agents/{agent_id}/knowledge-bases", {
  "knowledgebase_id": "kb_71ac0"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/agents/{agent_id}/knowledge-bases
result = vantax.request("POST", "/v1/agents/{agent_id}/knowledge-bases", json={"knowledgebase_id": "kb_71ac0"})

Response

{
  "success": true,
  "message": "Knowledge base assigned",
  "data": { "id": "agt_3d9b21", "knowledgebase_id": "kb_71ac0" }
}