Skip to main content
POST
Create Document Endpoint

Authorizations

Authorization
string
header
required

Your Folio API key, sent as Authorization: Bearer <api_key>.

Headers

idempotency-key
string | null
Maximum string length: 255
authorization
string | null

Body

multipart/form-data
file
file
required

The document to process.

deidentify
boolean
default:false
document_type
string | null
extraction_schema
string | null

JSON-encoded CustomSchema.

extraction_schema_id
string | null
human_review_threshold
number | null
Required range: 0 <= x <= 1
include_recognition
boolean
default:false
language
enum<string>
default:auto
Available options:
fr,
en,
auto
metadata
string | null

JSON-encoded object, echoed back untouched.

Response

Successful Response

completed_at
string<date-time> | null
required
content_type
string | null
required
created_at
string<date-time>
required
document_type
string | null
required
expires_at
string<date-time> | null
required
filename
string | null
required
id
string
required
language
enum<string>
required
Available options:
fr,
en,
auto
metadata
Metadata · object | null
required
result_url
string
required
size_bytes
integer | null
required
status
enum<string>
required
Available options:
received,
queued,
processing,
completed,
partially_completed,
failed,
deleted
updated_at
string<date-time>
required
object
string
default:document