Skip to main content
POST
Create a shelf

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
file
file
required

PDF file to process (max 300 MB)

name
string

Display name for the shelf

qualityMode
enum<string>

Acceptance policy for API uploads. Ignored for dashboard/session uploads.

Available options:
balanced,
strict,
best_effort
review
enum<string>

Deprecated for API-key uploads. true is rejected because API uploads use straight-through processing.

Available options:
true,
false
template
enum<string>

Template to apply for structuring

Available options:
book,
legal-contract,
charter-party,
academic-paper

Response

Shelf created, processing started

auditFindings
object[] | null
required
auditStatus
enum<string> | null
required
Available options:
passed,
repaired,
review_required
auditSummary
string | null
required
createdAt
string<date-time>
required
currentVersionNumber
integer | null
required
errorMessage
string | null
required
failedAtStep
string | null
required
mimeType
string
required
name
string
required
originalFileName
string
required
pageCount
number | null
required
publicId
string
required
Pattern: ^shf_[0-9a-f]{24}$
quality
object
required
repairAttempts
integer | null
required
Required range: x >= 0
reviewMode
boolean
required
status
enum<string>
required
Available options:
uploading,
parsing,
structuring,
verifying,
review,
ready,
failed
storageSizeBytes
number | null
required
template
string | null
required
updatedAt
string<date-time>
required
userId
string
required