Skip to main content
POST
/
v1
/
shelves
Create a shelf
curl --request POST \
  --url https://api.shelv.dev/v1/shelves \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'name=<string>'
{
  "auditFindings": [
    {
      "message": "<string>",
      "code": "<string>",
      "file": "<string>",
      "sourceRef": "<string>"
    }
  ],
  "auditSummary": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "currentVersionNumber": 123,
  "errorMessage": "<string>",
  "failedAtStep": "<string>",
  "mimeType": "<string>",
  "name": "<string>",
  "originalFileName": "<string>",
  "pageCount": 123,
  "publicId": "<string>",
  "quality": {
    "fallbackApplied": true
  },
  "repairAttempts": 1,
  "reviewMode": true,
  "storageSizeBytes": 123,
  "template": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.shelv.dev/llms.txt

Use this file to discover all available pages before exploring further.

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