Stable v1.0Last updated recently
Get Started

Get All Documents

Retrieve a paginated list of uploaded documents with filtering and search support.

Get All Documents

This endpoint allows you to retrieve a list of all documents uploaded to your account. Results are paginated and can be filtered by status or searched by keyword.

Endpoint

GET/api/v1/documents/get_documents

Retrieve all documents associated with your account.

Request Authentication

All requests must be authenticated using an API key sent in thex-api-key header.

Authentication Header
x-api-key: YOUR_API_KEY_HERE"

Query Parameters

Query Parameters

NameTypeDescription
page
IntegerPage number for pagination (starting from 1).
limit
IntegerNumber of documents to return per page.
status_filter
StringFilter documents by status (e.g. processing, completed, failed).
search
StringSearch documents by filename or extracted content.

Example Request

cURL – Get Documents
curl -X GET "/api/v1/documents/get_documents?page=1&limit=10&status_filter=completed&search=frontend" \
  -H "x-api-key: YOUR_API_KEY_HERE"

Response

The response includes a paginated list of documents along with metadata such as total count and current page.

200 OKDocuments retrieved successfully
Response Body
{
    "status": 200,
    "message": "Documents fetched successfully.",
    "result": {
        "total": 61,
        "page": 1,
        "limit": 10,
        "has_more": true,
        "documents": [
            {
                "id": 102,
                "user_id": 1,
                "original_filename": "imagedata.jpg",
                "file_type": "image",
                "file_size": 74356,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-13T15:04:27.734333+05:00",
                "updated_at": "2026-01-13T15:04:43.164338+05:00",
                "processed_at": "2026-01-13T10:04:59.073278+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/24eb986d-fb37-4910-8cea-fe0e1c68834c/imagedata.jpg"
            },
            {
                "id": 101,
                "user_id": 1,
                "original_filename": "imagedata.jpg",
                "file_type": "image",
                "file_size": 74356,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-13T10:13:40.580211+05:00",
                "updated_at": "2026-01-13T10:14:00.437289+05:00",
                "processed_at": "2026-01-13T05:14:21.799244+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/8e22b72e-0972-448a-ac38-282a4c774a55/imagedata.jpg"
            },
            {
                "id": 100,
                "user_id": 1,
                "original_filename": "Frontend Questions.docx",
                "file_type": "word",
                "file_size": 11895,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-13T09:47:05.040731+05:00",
                "updated_at": "2026-01-13T09:47:43.108929+05:00",
                "processed_at": "2026-01-13T04:48:13.913886+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/f7e3e0bc-f2e5-4f9c-af51-51771ef750de/Frontend Questions.docx"
            },
            {
                "id": 99,
                "user_id": 1,
                "original_filename": "users job code enabled (District for Testing).csv",
                "file_type": "excel",
                "file_size": 1175,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-13T09:47:03.647566+05:00",
                "updated_at": "2026-01-13T09:48:25.713416+05:00",
                "processed_at": "2026-01-13T04:49:06.013391+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/b08b07ce-3285-418a-b814-2ff4a92b4688/users job code enabled (District for Testing).csv"
            },
            {
                "id": 98,
                "user_id": 1,
                "original_filename": "dash1.PNG",
                "file_type": "image",
                "file_size": 69595,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T16:33:29.953386+05:00",
                "updated_at": "2026-01-13T09:48:01.836417+05:00",
                "processed_at": "2026-01-13T04:48:23.405692+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/8fc92215-9dae-4f5b-9d95-16e29f3eabf3/dash1.PNG"
            },
            {
                "id": 97,
                "user_id": 1,
                "original_filename": "medical_document_filled_sample 1.pdf",
                "file_type": "pdf",
                "file_size": 3114,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T15:56:15.070290+05:00",
                "updated_at": "2026-01-12T15:57:03.787516+05:00",
                "processed_at": "2026-01-12T10:57:35.016477+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/7f847cfb-5bd9-47dc-84c3-81b320637c4a/medical_document_filled_sample 1.pdf"
            },
            {
                "id": 96,
                "user_id": 1,
                "original_filename": "medical_document_detailed_extended 1.pdf",
                "file_type": "pdf",
                "file_size": 4393,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T15:56:06.651231+05:00",
                "updated_at": "2026-01-12T15:57:17.242849+05:00",
                "processed_at": "2026-01-12T10:57:52.631451+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/99303675-bc20-4e9d-8ef8-e0df778fa46a/medical_document_detailed_extended 1.pdf"
            },
            {
                "id": 94,
                "user_id": 1,
                "original_filename": "Staying informed is the first step to better health. MedicalGPT helps you access.png",
                "file_type": "image",
                "file_size": 682163,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T15:29:01.906045+05:00",
                "updated_at": "2026-01-12T15:29:24.062800+05:00",
                "processed_at": "2026-01-12T10:29:34.812625+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/cc97d2bf-0070-48c8-b754-b6a8a380f37e/Staying informed is the first step to better health. MedicalGPT helps you access.png"
            },
            {
                "id": 92,
                "user_id": 1,
                "original_filename": "1.docx",
                "file_type": "word",
                "file_size": 3267628,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T15:19:16.564760+05:00",
                "updated_at": "2026-01-12T15:20:25.631330+05:00",
                "processed_at": "2026-01-12T10:20:50.280482+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/429cd7df-ab1a-482d-9710-7977d4427b2a/1.docx"
            },
            {
                "id": 91,
                "user_id": 1,
                "original_filename": "1.pdf",
                "file_type": "pdf",
                "file_size": 445075,
                "status": "completed",
                "industry": null,
                "created_at": "2026-01-12T15:19:12.973686+05:00",
                "updated_at": "2026-01-12T15:23:46.301561+05:00",
                "processed_at": "2026-01-12T10:24:08.373816+05:00",
                "s3_url": "STORAGE_IMAGE_URL/1/10913a11-2444-46f1-8ef0-e529427a5ac4/1.pdf"
            }
        ]
    }
}

Error Responses

401 UnauthorizedMissing or invalid API key
Response Body
{
    "status": 401,
    "message": "API key required for API access",
    "result": null
}