Get document

Get a single document by ID

Updated 25 Jan 2026

On this page

This endpoint returns the details of a specific document within a knowledgebase.

Path Parameters

knowledgebaseIdintegerrequired

The unique identifier of the knowledgebase

documentIdintegerrequired

The unique identifier of the document

Response

dataobject

The document object

idinteger

  The unique identifier of the document

namestring

  The name of the document

descriptionstring

  Optional description of the document

typestring

  Document type: `website`, `pdf`, `txt`, or `docx`

type_labelstring

  Human-readable type label

statusstring

  Processing status: `processing`, `active`, or `failed`

status_labelstring

  Human-readable status label

created_atstring

  ISO 8601 timestamp of creation

updated_atstring

  ISO 8601 timestamp of last update

{
  "data": {
    "id": 1,
    "name": "Product Manual",
    "description": "Complete product user manual",
    "type": "pdf",
    "type_label": "PDF",
    "status": "active",
    "status_label": "Active",
    "created_at": "2025-01-05T10:30:00.000000Z",
    "updated_at": "2025-01-05T10:35:00.000000Z"
  }
}

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

{
  "error": "Document 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 →