Sign in

v1

latestOpenAPI 3.1.02026-07-263580186.3 KB
Files

Retrieve a single file by ID

Retrieve detailed information for a single file by its ID. Only files that the authenticated user is authorized to access will be returned. Returns 404 if the file does not exist or the user does not have access.

Query Parameters:

  • include_content: Set to 'true' to include the full text content of the document (default: false)

The response includes comprehensive document details including:

  • Basic metadata (id, filename, title, extension, dates, page count)
  • Full text content of the document (only when include_content=true)
  • Processing status (status, status_vision, status_detail if failed)
  • Associated tags and workspace information
  • File size (if available)
  • Parser/ingestion pipeline (if available, after parsing starts)
  • Signature (TLSH hash for duplicate detection)
  • Facet content types and nested attribute values (full expanded with attribute definitions)

Public datasets: reachable by instance admins (MANAGE_PUBLIC_DATASET) unconditionally, and by a company that has opted in (allow_access_to_public_datasets) with a workspace-scoped API key granting the file's public workspace.

get/api/v3/files/{id}

Path parameters

idinteger required

A unique integer value identifying this Document.

Query parameters

include_contentboolean

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. Always uses full expanded content types (Tier 3) with breadcrumb, code, and attribute definitions including type, required, and choices.

idinteger required
filenamestring required

Filename of the document

titlestring nullable
extensionstring required

File extension of the document

status'pending' | 'pending_conversion' | 'converting' | 'parsing' | 'parsing_failed' | 'embedding' | 'embedding_failed' | 'embedded' | 'parsed' | 'fail' | 'updating'
  • pending - Pending
  • pending_conversion - Pending Conversion
  • converting - Converting
  • parsing - Parsing
  • parsing_failed - Parsing Failed
  • embedding - Embedding
  • embedding_failed - Embedding Failed
  • embedded - Embedded
  • parsed - Parsed
  • fail - Fail
  • updating - Updating
status_vision'pending' | 'processing' | 'embedded' | 'fail' | '-'
  • pending - Pending
  • processing - Processing
  • embedded - Embedded
  • fail - Fail
  • - - Not available
created_atstring date-time required

Creation date of the resource

updated_atstring date-time required
total_pagesinteger required

Total number of pages

sizeinteger nullable

Size of the file in bytes.

upload_session_uuidstring uuid nullable required

Upload session UUID associated with this document

signaturestring nullable required

TLSH hash for duplicate detection.

contentstring nullable

Deprecated — use pages[] instead. Full text content of the document, derived from per-page text, as a single flat string. Only included when include_content=true query parameter is provided. Will be removed in a future release.

status_detailstring nullable

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

parserstring nullable

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