Skip to main content
GET
Get File

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fileId
string
required

Response

200 - application/json

FileResource

id
string
required

The file identifier, usable as a document id when creating quotes.

status
enum<string>
required
Available options:
pending,
processing,
ready,
failed
source
enum<string>
required
Available options:
direct_upload,
external_url
file_name
string | null
required
mime_type
string | null
required
size
integer | null
required
failure_message
string | null
required
created_at
string<date-time> | null
required
completed_at
string<date-time> | null
required