List files

GET

/files

• Production API

Authorizations

• bearerAuth
• cookieAuth

Parameters

Query Parameters

fileIds

Comma-separated list of file IDs to filter by

string

nullable

Comma-separated list of file IDs to filter by

teamIds

Comma-separated list of team IDs to filter by

string

nullable

Comma-separated list of team IDs to filter by

fileName

Filter by file name (partial match)

string

Filter by file name (partial match)

mimeTypes

Comma-separated list of MIME types to filter by

string

nullable

Comma-separated list of MIME types to filter by

processingStatus

Filter by processing status (JOB_CREATED, JOB_STARTED, JOB_FAILED, JOB_SUCCEEDED, none)

string

nullable

Filter by processing status (JOB_CREATED, JOB_STARTED, JOB_FAILED, JOB_SUCCEEDED, none)

uploadedBy

Filter by the user ID who uploaded the file

string

Filter by the user ID who uploaded the file

page

Page number for pagination (starts at 1)

number

>= 1

Page number for pagination (starts at 1)

pageSize

Number of results per page (1-100)

number

>= 1 <= 100

Number of results per page (1-100)

orderBy

Field to sort results by

string

Allowed values: createdAt fileName fileSize updatedAt

Field to sort results by

orderDirection

Sort direction (asc or desc)

string

Allowed values: asc desc

Sort direction (asc or desc)

Responses

200

Files retrieved successfully

object

files

required

Array of file objects

Array<object>

object

fileId

required

Unique identifier for the file

string

teamId

required

ID of the team that owns this file

string

fileName

required

File name or relative path (e.g., ‘file.txt’ or ‘docs/file.txt’). Slashes preserved for directory structure.

string

fileSize

required

Size of the file in bytes

number

mimeType

required

MIME type of the file (e.g., text/csv, application/json)

string

fileHash

required

SHA-256 hash of the file contents for deduplication

string

uploadedBy

required

User ID of who uploaded this file, or null for system uploads

string

nullable

sourceUrl

required

Source URL if file was ingested from a URL, or null for direct uploads

string format: uri

nullable

metadata

required

Custom key-value metadata attached to the file

object

key

additional properties

nullable

processingStatus

required

Latest processing status for the file, or null if never processed

object

eventType

required

Type of the latest processing event (JOB_CREATED, JOB_STARTED, JOB_FAILED, JOB_SUCCEEDED)

string

Allowed values: JOB_CREATED JOB_STARTED JOB_FAILED JOB_SUCCEEDED

createdAt

required

When this processing event occurred

string format: date-time

processorVersion

required

Version of the processor that handled this file

string

eventData

Additional event-specific data

nullable

createdAt

required

When the file was uploaded

string format: date-time

updatedAt

required

When the file was last modified

string format: date-time

total

required

Total number of files matching the query

number

page

required

Current page number

number

pageSize

required

Number of results per page

number

400

Bad Request - Validation error or invalid input

object

error

required

string

code

string

details

nullable

retryable

boolean

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

500

Internal Server Error - Unexpected server error

object

error

required

string

code

string

details

nullable

retryable

boolean