Agent Documents
Check knowledge-base indexing progress
Per-document indexing state for one agent, plus a summary count by status. An agent cannot use a document during a call until its sync_status is synced.
providers shows which search backends have finished indexing that document — useful when one backend lags behind the others.
GET
/
agent
/
{id}
/
documents
/
sync-status
Check knowledge-base indexing progress
curl --request GET \
--url https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status', 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/agent/{id}/documents/sync-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"summary": {
"total": 3,
"pending": 0,
"syncing": 1,
"synced": 2,
"failed": 0,
"deleted": 0
},
"documents": [
{
"document_id": "d1234567-abcd-1234-abcd-123456789012",
"name": "Product FAQ.pdf",
"type": "file",
"sync_status": "synced",
"sync_error": null,
"synced_at": "2026-08-26T12:01:14.000Z",
"linked_at": "2026-08-26T12:00:58.000Z",
"providers": {
"supermemory": true,
"gemini": true,
"vertex": true,
"azure": false
}
},
{
"document_id": "d3456789-abcd-1234-abcd-123456789012",
"name": "Refund policy",
"type": "paragraph",
"sync_status": "syncing",
"sync_error": null,
"synced_at": null,
"linked_at": "2026-08-26T12:02:03.000Z",
"providers": {
"supermemory": true,
"gemini": false,
"vertex": false,
"azure": false
}
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "status must be one of: pending, syncing, synced, failed, deleted"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"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.
Path Parameters
Agent ID.
Query Parameters
Return only documents in this sync state. The summary always counts all of them.
Available options:
pending, syncing, synced, failed, deleted ⌘I
Check knowledge-base indexing progress
curl --request GET \
--url https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status', 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/agent/{id}/documents/sync-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vocobase.com/api/v2/agent/{id}/documents/sync-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"summary": {
"total": 3,
"pending": 0,
"syncing": 1,
"synced": 2,
"failed": 0,
"deleted": 0
},
"documents": [
{
"document_id": "d1234567-abcd-1234-abcd-123456789012",
"name": "Product FAQ.pdf",
"type": "file",
"sync_status": "synced",
"sync_error": null,
"synced_at": "2026-08-26T12:01:14.000Z",
"linked_at": "2026-08-26T12:00:58.000Z",
"providers": {
"supermemory": true,
"gemini": true,
"vertex": true,
"azure": false
}
},
{
"document_id": "d3456789-abcd-1234-abcd-123456789012",
"name": "Refund policy",
"type": "paragraph",
"sync_status": "syncing",
"sync_error": null,
"synced_at": null,
"linked_at": "2026-08-26T12:02:03.000Z",
"providers": {
"supermemory": true,
"gemini": false,
"vertex": false,
"azure": false
}
}
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "status must be one of: pending, syncing, synced, failed, deleted"
}
}{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Resource not found"
}
}{
"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"
}
}