POST
/
apps
/
{app_id}
/
files

Path Parameters

app_id
string
required

The ID of the app

Body

allowed_types
string[]

The allowed mime types for the file field (e.g. image/*, application/pdf)

document_extract_contents
boolean

Flag indicating whether to extract contents from the document

document_extract_images
boolean

Flag indicating whether to extract images from the document

document_extract_pages
boolean

Flag indicating whether to extract pages from the document

document_max_pages
number

Maximum number of pages to extract from the document

Required range: x > 1
document_pages
number[]

Array of page numbers to extract from the document

file

File to be uploaded. It can be a file object, a base64 encoded string, or a file data object containing base64 data, name, and type.

file_url
string

URL of the file to be uploaded

Response

200 - application/json

Detailed information about a file

created_at
string | null
required

Timestamp when the file was created

document_extract_contents
boolean
required

Flag indicating whether to extract contents from the document

document_extract_images
boolean
required

Flag indicating whether to extract images from the document

document_extract_pages
boolean
required

Flag indicating whether to extract pages from the document

file_filename
string
required

Name of the file

file_format
enum<string> | null
required

Format of the file

Available options:
DOCUMENT
file_id
string
required

File identifier used in the storage system

file_mimetype
string
required

MIME type of the file

file_size
number
required

Size of the file in bytes

file_url
string
required

URL to access the file

id
string
required

Unique identifier for the file

document
object | null

Document data associated with the file

document_pages
number[]

Array of page numbers to extract from the document

document_progress
number

Progress of the document extraction process

file_status
enum<string>

Current status of the file

Available options:
PROCESSING,
PROCESSED,
FAILED
file_status_message
string

Status message providing additional information about the file status