Skip to content

Process file

POST
/files/{fileId}/process

Triggers background processing of the file (PDF extraction, chunking, etc.). Returns a job ID for tracking progress.

fileId
required

Unique identifier of the file to retrieve

string

Unique identifier of the file to retrieve

object
force

Force reprocessing even if already processed

boolean

Processing job already exists

object
jobId
required

ID of the background job that will process the file

string
fileId
required

ID of the file being processed

string
status
required

Current status of the processing job

string
Allowed values: pending claimed running succeeded failed cancelled
message
required

Human-readable status message

string

Processing job created

object
jobId
required

ID of the background job that will process the file

string
fileId
required

ID of the file being processed

string
status
required

Current status of the processing job

string
Allowed values: pending claimed running succeeded failed cancelled
message
required

Human-readable status message

string

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