List Knowledge Base Documents

GET

documents

curl --request GET \
  --url https://api.dialnexa.com/v1/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/documents', 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.dialnexa.com/v1/documents",
  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.dialnexa.com/v1/documents"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/documents")

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,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "Dk4mP8vQ2nLz7x",
        "title": "Support FAQ",
        "knowledge_base_id": "abc123def45678",
        "description": "",
        "content": "How do I reset my password? Open Settings and choose Reset password.",
        "source": "",
        "document_type": "txt",
        "file_size": 0.0664,
        "file_path": "knowledge-documents/abc123def45678/Support_FAQ-Dk4mP8vQ2nLz7x.txt",
        "is_deleted": false,
        "ingest_status": "processing",
        "ingest_error": null,
        "ingest_updated_at": "2026-07-03T10:30:00.000Z",
        "ingest_job_id": "3f6c2a9e-8b1d-4e7a-9c5f-2d8e1b7a4c63"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

Read only List knowledge base documents to verify an upload or inspect the non-deleted files in a knowledge base. Results are paginated. Each document carries its id, title, knowledge_base_id, description, source, document_type, file_size, file_path, the full extracted text in content, and its indexing state in ingest_status, ingest_error, ingest_updated_at and ingest_job_id. Document IDs and knowledge_base_id are raw, without a prefix.

Before you begin

Use a knowledge base ID from List Knowledge Bases.
Send a valid workspace API key.

List Knowledge Base Documents Request

GET /v1/documents?knowledge_base_id=kb_abc123&page=1&limit=10

Query parameters

Parameter	Description
`knowledge_base_id`	Required. Knowledge base ID, with or without the `kb_` prefix. Missing returns `400`.
`page`	Page number. Default: `1`.
`limit`	Documents per page. Default: `10`. Each document includes its full text, so keep pages small.
`sortBy`	Document field to sort by. Default: `id`.
`sortOrder`	Sort direction: `ASC` or `DESC`, in any case. Default: `ASC`. Any other value fails with `500`.

Verify the result

Read data.items and data.meta in the 200 response. Pagination metadata includes totalItems, itemsPerPage, totalPages, and currentPage. Match an uploaded document by ID and title. file_size is in KB, with 1024 bytes per KB.

Errors and recovery

401 means the API key is missing or invalid. 400 means knowledge_base_id is missing, or page or limit is a decimal. 404 means the knowledge base ID does not exist in your workspace or the knowledge base has been deleted. Because document listings carry the full text of every file, DialNexa does not confirm that a knowledge base belongs to another workspace, so a valid ID you do not own returns the same 404 as one that was never created. Check the ID against List Knowledge Bases. Send page and limit as whole numbers of at least 1: a value that is not a number is ignored and the default is used, a decimal returns 400, limit=0 returns an empty page, and page=0 fails with 500. Use a valid document field for sortBy; an unknown field also fails with 500. sortOrder accepts ASC or DESC in any case; any other value fails with 500. This read is safe to retry.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

knowledge_base_id

string

required

Knowledge base ID.

Example:

"kb_abc123def45678"

page

integer

default:1

Page number.

limit

integer

default:10

Documents per page.

sortBy

string

default:id

Document field to sort by.

sortOrder

string

default:ASC

Sort direction: ASC or DESC, in any case. Default ASC. Any other value fails with 500.

Response

Successful response.

success

boolean

required

error

boolean

required

statusCode

integer

required

message

string

required

data

object

required

Show child attributes

timestamp

string<date-time>

required

List Knowledge Base Documents

curl --request GET \
  --url https://api.dialnexa.com/v1/documents \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/documents', 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.dialnexa.com/v1/documents",
  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.dialnexa.com/v1/documents"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/documents")

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,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "Dk4mP8vQ2nLz7x",
        "title": "Support FAQ",
        "knowledge_base_id": "abc123def45678",
        "description": "",
        "content": "How do I reset my password? Open Settings and choose Reset password.",
        "source": "",
        "document_type": "txt",
        "file_size": 0.0664,
        "file_path": "knowledge-documents/abc123def45678/Support_FAQ-Dk4mP8vQ2nLz7x.txt",
        "is_deleted": false,
        "ingest_status": "processing",
        "ingest_error": null,
        "ingest_updated_at": "2026-07-03T10:30:00.000Z",
        "ingest_job_id": "3f6c2a9e-8b1d-4e7a-9c5f-2d8e1b7a4c63"
      }
    ],
    "meta": {
      "totalItems": 1,
      "itemsPerPage": 10,
      "totalPages": 1,
      "currentPage": 1
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

Overview

Endpoints

Before you begin

List Knowledge Base Documents Request

Query parameters

Verify the result

Errors and recovery

Authorizations

Query Parameters

Response

​Before you begin

​List Knowledge Base Documents Request

​Query parameters

​Verify the result

​Errors and recovery

​Related endpoints

Authorizations

Query Parameters

Response

Before you begin

List Knowledge Base Documents Request

Query parameters

Verify the result

Errors and recovery

Related endpoints