Skip to content

Get file summary

GET
/file-summaries/{fileId}

Retrieve the summary for a file. Summaries are pre-computed during file processing or generated just-in-time.

fileId
required

Unique identifier of the file to get summary for

string

Unique identifier of the file to get summary for

File summary found

object
fileSummaryId
required

Unique identifier for the file summary record

string
fileId
required

ID of the file this summary belongs to

string
description
required

High-level description of the document’s contents

string
documentType
required

Document type classification (e.g., ‘financial_report’, ‘contract’)

string
nullable
pageCount
required

Number of pages in the document

number
nullable
sections
required

Sections within the document with headings and summaries

Array<object>
nullable
object
heading
required

Section heading or title

string
summary
required

Brief summary of this section’s content

string
entities
required

Named entities extracted from the document

Array<object>
nullable
object
name
required

Entity name as it appears in the document

string
type
required

Entity type (e.g., ‘person’, ‘organization’, ‘date’)

string
generationMethod
required

How the summary was generated

string
Allowed values: pre-computed jit
createdAt
required

When the summary was created

string format: date-time

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean