Skip to content

Get file by ID

GET
/files/{fileId}
fileId
required

Unique identifier of the file to retrieve

string

Unique identifier of the file to retrieve

File found

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

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

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