List Documents

Retrieve all documents and categories for the authenticated user.

This endpoint returns a comprehensive list of all documents uploaded by the user, including their metadata, processing status, and available document categories with counts.

Returns:

• List of document objects, each containing:

  • id: Unique document identifier
  • filename: Original filename
  • type: File type/MIME type
  • size: File size in bytes
  • upload_date: ISO 8601 timestamp of upload
  • status: Processing status (e.g., COMPLETED, PROCESSING, FAILED)
  • categories: List of category names assigned to this document
  • uploader: Username of the uploader
  • processing_progress (optional): Processing progress percentage (0-100)

• categories: List of category objects, each containing:

  • name: Category name
  • count: Number of documents in this category

Example Request:

GET /api/v3/documents
Headers: {"Authorization": "Bearer <api_key>"}

Example Response:

{
  "documents": [
    {
      "id": "doc-abc123",
      "filename": "quarterly_report.jsom",
      "size": 102400,
      "upload_date": "2024-01-15T10:30:00Z",
      "status": "COMPLETED",
      "categories": ["financial", "2024"],
      "uploader": "john.doe@example.com",
      "processing_progress": 100
    },
    {
      "id": "doc-xyz789",
      "filename": "meeting_notes.txt",
      "size": 45678,
      "upload_date": "2024-01-16T14:20:00Z",
      "status": "processing",
      "categories": ["meetings"],
      "uploader": "john.doe@example.com",
      "processing_progress": 65
    }
  ],
  "categories": [
    {
      "name": "financial",
      "count": 5
    },
    {
      "name": "2024",
      "count": 12
    },
    {
      "name": "meetings",
      "count": 8
    }
  ]
}

Notes:

• Categories are automatically extracted and organized for easy filtering
• Each category shows the total count of documents tagged with that category