Skip to main content
GET
/
api
/
v3
/
files
List files accessible to the authenticated user
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/files \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    [
      {
        "id": 123,
        "filename": "project_proposal.pdf",
        "workspace": 1,
        "title": "Q4 Project Proposal",
        "extension": "pdf",
        "status": "embedded",
        "status_vision": "embedded",
        "uploaded_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:35:00Z",
        "total_pages": 25,
        "tags": [
          {
            "id": 10,
            "name": "Project X",
            "color": "#FF5733"
          }
        ]
      },
      {
        "id": 124,
        "filename": "meeting_notes.docx",
        "workspace": 2,
        "title": "Team Meeting Notes - January",
        "extension": "docx",
        "status": "embedded",
        "status_vision": "-",
        "uploaded_at": "2024-01-14T14:20:00Z",
        "updated_at": "2024-01-14T14:22:00Z",
        "total_pages": 8,
        "tags": []
      },
      {
        "id": 125,
        "filename": "data_analysis.xlsx",
        "workspace": null,
        "title": "Sales Data Analysis",
        "extension": "xlsx",
        "status": "parsing",
        "status_vision": "-",
        "uploaded_at": "2024-01-16T09:15:00Z",
        "updated_at": "2024-01-16T09:16:00Z",
        "total_pages": 1,
        "tags": []
      }
    ]
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
extension
string

Filter by file extensions (comma-separated, e.g., ?extension=pdf,docx)

​
filename
string

Filter by filename (case-insensitive partial match)

​
max_documents
integer

Maximum number of documents to return (default: 50, minimum: 1, maximum: 500)

​
page
integer

A page number within the paginated result set.

​
search
string

Optional semantic search query. When provided, results are ordered by relevance.

​
status
enum<string>

Filter by status values (comma-separated, e.g., ?status=pending,embedded)

Available options:
embedded,
embedding,
embedding_failed,
fail,
parsing,
parsing_failed,
pending,
updating
​
status_vision
enum<string>

Filter by vision status values (comma-separated, e.g., ?status_vision=pending,embedded)

Available options:
-,
embedded,
fail,
pending,
processing
​
tag_id
string

Filter by tag IDs (comma-separated, e.g., ?tag_id=1,2,3)

​
title
string

Filter by title (case-insensitive partial match)

​
total_pages_max
integer | null

Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)

Required range: -2147483648 <= x <= 2147483647
​
total_pages_min
integer | null

Filter by total pages range (e.g., ?total_pages_min=10&total_pages_max=50)

Required range: -2147483648 <= x <= 2147483647
​
updated_at_after
string<date-time>

Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)

​
updated_at_before
string<date-time>

Filter by updated_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?updated_at_after=2024-01-01&updated_at_before=2024-01-01T23:59:59)

​
uploaded_at_after
string<date-time>

Filter by uploaded_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?uploaded_at_after=2024-01-01&uploaded_at_before=2024-01-01T23:59:59)

​
uploaded_at_before
string<date-time>

Filter by uploaded_at date range (inclusive, date-only strings treated as 00:00:00, e.g., ?uploaded_at_after=2024-01-01&uploaded_at_before=2024-01-01T23:59:59)

​
workspace_id
string

Filter by workspace IDs (comma-separated, e.g., ?workspace_id=1,2,3)

Response

List of files accessible to the authenticated user

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"