Documents
Add a paragraph document
Creates a knowledge-base document straight from text — no presigned upload round trip. Use it for short policies, FAQs, and snippets you generate rather than store as files.
The document is returned already ready; link it to an agent with POST /agent/{id}/documents.
POST
/
documents
/
paragraph
Add a paragraph document
curl --request POST \
--url https://api.vocobase.com/api/v2/documents/paragraph \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Refund policy",
"content": "Refunds are issued within 7 business days of approval...",
"description": "Current refund terms"
}
'import requests
url = "https://api.vocobase.com/api/v2/documents/paragraph"
payload = {
"name": "Refund policy",
"content": "Refunds are issued within 7 business days of approval...",
"description": "Current refund terms"
}
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({
name: 'Refund policy',
content: 'Refunds are issued within 7 business days of approval...',
description: 'Current refund terms'
})
};
fetch('https://api.vocobase.com/api/v2/documents/paragraph', 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://api.vocobase.com/api/v2/documents/paragraph",
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([
'name' => 'Refund policy',
'content' => 'Refunds are issued within 7 business days of approval...',
'description' => 'Current refund terms'
]),
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://api.vocobase.com/api/v2/documents/paragraph"
payload := strings.NewReader("{\n \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\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://api.vocobase.com/api/v2/documents/paragraph")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/documents/paragraph")
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 \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d3456789-abcd-1234-abcd-123456789012",
"name": "Refund policy",
"type": "paragraph",
"status": "ready",
"description": "Current refund terms",
"agent_count": 0,
"created_at": "2026-08-26T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "content is required"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 60 seconds."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}Authorizations
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
Body
application/json
⌘I
Add a paragraph document
curl --request POST \
--url https://api.vocobase.com/api/v2/documents/paragraph \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Refund policy",
"content": "Refunds are issued within 7 business days of approval...",
"description": "Current refund terms"
}
'import requests
url = "https://api.vocobase.com/api/v2/documents/paragraph"
payload = {
"name": "Refund policy",
"content": "Refunds are issued within 7 business days of approval...",
"description": "Current refund terms"
}
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({
name: 'Refund policy',
content: 'Refunds are issued within 7 business days of approval...',
description: 'Current refund terms'
})
};
fetch('https://api.vocobase.com/api/v2/documents/paragraph', 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://api.vocobase.com/api/v2/documents/paragraph",
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([
'name' => 'Refund policy',
'content' => 'Refunds are issued within 7 business days of approval...',
'description' => 'Current refund terms'
]),
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://api.vocobase.com/api/v2/documents/paragraph"
payload := strings.NewReader("{\n \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\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://api.vocobase.com/api/v2/documents/paragraph")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/documents/paragraph")
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 \"name\": \"Refund policy\",\n \"content\": \"Refunds are issued within 7 business days of approval...\",\n \"description\": \"Current refund terms\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d3456789-abcd-1234-abcd-123456789012",
"name": "Refund policy",
"type": "paragraph",
"status": "ready",
"description": "Current refund terms",
"agent_count": 0,
"created_at": "2026-08-26T12:00:00.000Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "content is required"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 60 seconds."
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
}
}