Skip to main content
POST
/
v1
/
shelves
/
{id}
/
upload
Upload new PDF
curl --request POST \
  --url https://api.shelv.dev/v1/shelves/{id}/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "auditFindings": [
    {
      "check": "naming",
      "message": "<string>",
      "severity": "error",
      "code": "<string>",
      "file": "<string>",
      "sourceRef": "<string>"
    }
  ],
  "auditStatus": "passed",
  "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,
    "granularity": "document",
    "mode": "balanced",
    "tier": "full"
  },
  "repairAttempts": 1,
  "reviewMode": true,
  "status": "uploading",
  "storageSizeBytes": 123,
  "template": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Pattern: ^shf_[0-9a-f]{24}$

Body

multipart/form-data
file
file
required

PDF file to process (max 300 MB)

Response

Re-upload 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