Get knowledgebase

Get a single knowledgebase by ID

Updated 25 Jan 2026

On this page

This endpoint returns the details of a specific knowledgebase.

Path Parameters

idintegerrequired

The unique identifier of the knowledgebase

Response

dataobject

The knowledgebase object

idinteger

  The unique identifier of the knowledgebase

namestring

  The name of the knowledgebase

descriptionstring

  Optional description of the knowledgebase

statusstring

  Current status: `empty`, `processing`, `active`, or `failed`

status_labelstring

  Human-readable status label

documents_countinteger

  Number of documents in this knowledgebase

assistants_countinteger

  Number of assistants using this knowledgebase

created_atstring

  ISO 8601 timestamp of creation

updated_atstring

  ISO 8601 timestamp of last update

{
  "data": {
    "id": 1,
    "name": "Product Documentation",
    "description": "Technical documentation for our products",
    "status": "active",
    "status_label": "Active",
    "documents_count": 5,
    "assistants_count": 2,
    "created_at": "2025-01-05T10:30:00.000000Z",
    "updated_at": "2025-01-08T14:20:00.000000Z"
  }
}

{
  "error": "Knowledgebase not found."
}

Related guides

API Reference

Introduction

Welcome to the VoxLink API

Read guide →

API Reference

Authentication

Learn how to authenticate your API requests

Read guide →

API Reference

Get current user

Get the authenticated user's profile information

Read guide →

API Reference

List assistants

List all assistants for the authenticated user with pagination

Read guide →