List file summaries

GET

/file-summaries

• Production API

List file summaries with optional filtering by file IDs, document type, and generation method. Supports pagination and ordering.

Authorizations

• bearerAuth
• cookieAuth

Parameters

Query Parameters

fileSummaryIds

Filter by file summary IDs (comma-delimited)

Array<string>

nullable

Filter by file summary IDs (comma-delimited)

fileIds

Filter by file IDs (comma-delimited)

Array<string>

nullable

Filter by file IDs (comma-delimited)

documentType

Filter by document type

string

Filter by document type

generationMethod

Filter by generation method

string

Allowed values: pre-computed jit

Filter by generation method

page

Page number for pagination (1-indexed)

number

>= 1

Page number for pagination (1-indexed)

pageSize

Number of results per page (1-100, default: 10)

number

>= 1 <= 100

Number of results per page (1-100, default: 10)

orderBy

Field to sort results by

string

Allowed values: createdAt updatedAt documentType

Field to sort results by

orderDirection

Sort direction: ascending or descending

string

Allowed values: asc desc

Sort direction: ascending or descending

Responses

200

List of file summaries

object

fileSummaries

required

Array of file summaries

Array<object>

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

total

required

Total number of matching records

integer

page

required

Current page number

integer

pageSize

required

Number of items per page

integer

401

Unauthorized - Authentication required or invalid token

object

error

required

string

code

string

details

nullable

retryable

boolean

403

Forbidden - Insufficient permissions

object

error

required

string

code

string

details

nullable

retryable

boolean