Bulk create KB documents
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"docs": [
{
"name": "<string>",
"sourceType": "doc",
"content": "<string>",
"urls": [
"<string>"
],
"tags": [
"<string>"
],
"metadata": {
"description": "<string>"
}
}
]
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk"
payload = { "docs": [
{
"name": "<string>",
"sourceType": "doc",
"content": "<string>",
"urls": ["<string>"],
"tags": ["<string>"],
"metadata": { "description": "<string>" }
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
docs: [
{
name: '<string>',
sourceType: 'doc',
content: '<string>',
urls: ['<string>'],
tags: ['<string>'],
metadata: {description: '<string>'}
}
]
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'docs' => [
[
'name' => '<string>',
'sourceType' => 'doc',
'content' => '<string>',
'urls' => [
'<string>'
],
'tags' => [
'<string>'
],
'metadata' => [
'description' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk"
payload := strings.NewReader("{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": [
{
"status": "<string>",
"docId": "<string>",
"name": "<string>",
"error": "<string>"
}
]
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Knowledge Base
Bulk Create KB Docs
Create up to 20 knowledge base documents in one request.
POST
/
agents
/
{agentId}
/
kb
/
docs
/
bulk
Bulk create KB documents
curl --request POST \
--url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"docs": [
{
"name": "<string>",
"sourceType": "doc",
"content": "<string>",
"urls": [
"<string>"
],
"tags": [
"<string>"
],
"metadata": {
"description": "<string>"
}
}
]
}
'import requests
url = "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk"
payload = { "docs": [
{
"name": "<string>",
"sourceType": "doc",
"content": "<string>",
"urls": ["<string>"],
"tags": ["<string>"],
"metadata": { "description": "<string>" }
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
docs: [
{
name: '<string>',
sourceType: 'doc',
content: '<string>',
urls: ['<string>'],
tags: ['<string>'],
metadata: {description: '<string>'}
}
]
})
};
fetch('https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'docs' => [
[
'name' => '<string>',
'sourceType' => 'doc',
'content' => '<string>',
'urls' => [
'<string>'
],
'tags' => [
'<string>'
],
'metadata' => [
'description' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk"
payload := strings.NewReader("{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/kb/docs/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"docs\": [\n {\n \"name\": \"<string>\",\n \"sourceType\": \"doc\",\n \"content\": \"<string>\",\n \"urls\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"metadata\": {\n \"description\": \"<string>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"results": [
{
"status": "<string>",
"docId": "<string>",
"name": "<string>",
"error": "<string>"
}
]
}{
"message": "<string>",
"code": "<string>",
"issues": [
{
"message": "<string>"
}
]
}Request
{
"docs": [
{
"name": "Policies",
"sourceType": "doc",
"content": "Check-in is from 3pm…",
"tags": ["policies"]
},
{
"name": "Dining",
"sourceType": "doc",
"content": "Breakfast is served 6:30–10:30…",
"tags": ["dining"]
}
]
}
sourceType: "doc" is supported in bulk; use POST /agents/{agentId}/kb for URL/sitemap sources.
Response
{
"success": true,
"results": [
{ "docId": "abc", "status": "success", "name": "Policies" },
{ "name": "Dining", "status": "error", "error": "…" }
]
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
⌘I
