List Documents

Overview

The Get All Documents endpoint retrieves a list of all documents that have been uploaded and processed by the authenticated user on the KnowledgeVerse AI platform. Each document entry includes processing status, unique identifiers, and transaction consumption details.

Use this endpoint to:

Retrieve a list of all uploaded documents.
Check document processing status.
Get document process IDs for further operations (search, retrieval, etc.).
Monitor transaction usage per document.
Build document management dashboards.

Endpoint Details

Method: GET
Endpoint: /api/doc/get_all
Base URL: https://api.k-v.ai
Authentication: Access Key (Required)

Request Specification

Headers

Header	Type	Required	Description
access-key	string	Yes	Your unique access-key generated from the platform UI

Query Parameters

None required. This endpoint returns all documents associated with the authenticated user.

Response Specification

Success Response (200 OK)

{
    "data": [
        {
            "created_at": "10 December 2025 10:15",
            "doc_name": "2511.00285v1.pdf",
            "status": "processed",
            "doc_process_id": "c71a96e072b581f1108dbc5f7a93cd54",
            "transactions_utilised": 117
        },
        {
           "created_at": "11 December 2025 10:00",
           "doc_name": "Settlement Agreement (1).pdf",
           "status": "processing",
           "doc_process_id": null,
           "transactions_utilised": null
       },
    ],
    "message": "Successfully fetched all documents"
}

Response Fields

Field	Type	Description
data	array	List of document objects
data[].created_at	string	Timestamp when document was uploaded (format: "DD Month YYYY HH:MM")
data[].doc_name	string	Original filename of the uploaded document
data[].status	string	Current processing status of the document.
data[].doc_process_id	string	Unique identifier for the document (32-character hex string)
data[].transactions_utilised	integer	Number of transactions consumed during processing
message	string	Human-readable response message

Document Status Values

Status	Description
processed	Document successfully processed and ready for use
processing	Document currently being processed
failed	Document processing failed

Important Notes

doc_process_id: This unique identifier is crucial for subsequent operations like searching within the document, retrieving content, or deleting the document.
Transaction Costs: Vary based on document size, complexity, and file type (PDF, DOCX, PPTX)
Supported Formats: PDF, DOCX, PPTX

Error Responses

401 Unauthorized

{
    "data": {},
    "message": "Invalid or missing access key"
}

Cause: Missing or invalid access-key header.

500 Internal Server Error

{
    "data": {},
    "message": "Something went wrong"
}

Cause: Server-side processing error or database connectivity issue.

Code Snippets

curl --location 'https://api.k-v.ai/api/doc/get_all' \
--header 'access-key: YOUR_ACCESS_KEY'

import requests

url = "https://api.k-v.ai/api/doc/get_all"

payload = {}
headers = {
  'access-key': 'YOUR_ACCESS_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.k-v.ai/api/doc/get_all',
  headers: { 
    'access-key': 'YOUR_ACCESS_KEY'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Data Retention

Documents remain accessible until manually deleted.
Processed documents persist for 100 days.

Next Steps

After retrieving your document list:

Upload New Documents
Use Knowledge Agents
Delete Documents

Need Help? Contact support at support@k-v.ai

List Documents

On this page