Skip to main content
GET
/
api
/
v3
/
files
/
{id}
Retrieve a single file by ID
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/files/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "filename": "project_proposal.pdf",
  "workspace": {
    "id": 1,
    "name": "Engineering Team"
  },
  "summaries": [
    {
      "language": "en",
      "summary": "This document outlines Q4 initiatives..."
    }
  ],
  "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",
      "auto_assigned": false
    }
  ],
  "signature": "T1A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0U1V2W3X4Y5Z6A7B8C9D0E1F2",
  "file_size": 2458624,
  "parser": "v3.0"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

A unique integer value identifying this Document.

Query Parameters

​
include_content
boolean

When true, include the full text content of the document in the response (default: false). Recommended to only enable when needed as content can be large.

Response

Detailed file information

​
id
integer
required
​
filename
string
required

Filename of the document

​
workspace
object
required

Workspace the document belongs to

​
summaries
object[]
required

Document summaries (all languages)

​
extension
string
required

File extension of the document

​
uploaded_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
total_pages
integer
required

Total number of pages

​
tags
object[]
required

List of tags associated with the document

​
upload_session_uuid
string<uuid> | null
required

Upload session UUID associated with this document

​
signature
string | null
required

TLSH hash for duplicate detection.

​
file_size
integer | null
required

Size of the file in bytes. Only present if file is available.

​
title
string | null
Maximum string length: 255
​
status
enum<string>
  • pending - Pending
  • parsing - Parsing
  • parsing_failed - Parsing Failed
  • embedding - Embedding
  • embedding_failed - Embedding Failed
  • embedded - Embedded
  • fail - Fail
  • updating - Updating
Available options:
pending,
parsing,
parsing_failed,
embedding,
embedding_failed,
embedded,
fail,
updating
​
status_vision
enum<string>
  • pending - Pending
  • processing - Processing
  • embedded - Embedded
  • fail - Fail
  • - - Not available
Available options:
pending,
processing,
embedded,
fail,
-
​
content
string | null

Full text content of the document. Only included when include_content=true query parameter is provided.

​
status_detail
string | null

Detailed error information. Only present when document processing has failed.

​
parser
string | null

Parser/ingestion pipeline used for document processing (e.g., 'v2.1', 'v3.0').