input | string | object | Input The PDF reference as submitted (data: URIs are shown as a short label). |
status | string | Status ok | not_found | error | skipped_invalid | skipped_budget | skipped_free_plan | skipped_unmetered e.g. "ok" |
charged | boolean | Charged Whether the record's pdf event was charged. |
chargedEvent | string | Charged event Pay-per-event event charged for this record (present only when charged). |
chargedCount | integer | Events charged Events actually charged when the charge came back short (present only then). |
source | string | Source pdf-text-layer: the PDF's own text layer, read in the Actor. |
fetchedAt | string | Fetched at ISO timestamp. |
error | object | Error { code, message, status? } when status is not ok. Codes: invalid_reference, document_too_large, document_not_found, not_a_pdf, not_readable, encrypted_pdf, wrong_password, corrupt_pdf, no_pages, timeout, fetch errors (blocked_url, dns_not_found, network, http_error, …) and the runtime codes (budget_exhausted, free_plan_limit, …). |
warnings | array | Warnings Notes: page limits, budget limits, text moved to the key-value store. |
url | string | null | URL URL the PDF was downloaded from (after redirects); the record URL for key-value store records; null for data: URIs. |
fileName | string | null | File name |
fileSizeBytes | integer | null | File size (bytes) |
sha256 | string | null | SHA-256 Hash of the PDF bytes (deduplication). |
title | string | null | Title Document title from the metadata, else the first heading. |
pageCount | integer | null | Pages in PDF |
pagesExtracted | integer | null | Pages extracted |
pageRange | string | null | Page range The requested page range, or null for every page. |
possiblyTruncated | boolean | null | Truncated Fewer pages were returned than the range selects (maxPagesPerPdf, free plan, budget or time limit). |
metadata | object | null | Metadata { title, author, subject, keywords[], creator, producer, createdAt, modifiedAt, pdfVersion, language, pageCount, encrypted, linearized, hasForm, pageWidth, pageHeight } |
language | string | null | Language Detected language of the text (ISO 639-1). |
hasTextLayer | boolean | null | Has text layer At least one returned page has extractable text. |
textPages | integer | null | Pages with text Pages with a usable text layer. |
scannedPages | array | null | Scanned pages Pages without a usable text layer that show an image or drawings: OCR them with pdf-ocr-markdown. |
blankPages | array | null | Blank pages |
ocrRecommended | boolean | null | OCR recommended |
ocrSuggestion | string | null | OCR suggestion |
charCount | integer | null | Characters |
wordCount | integer | null | Words |
markdown | string | null | Markdown All returned pages, separated by <!-- page N --> comments. |
markdownUrl | string | null | Full Markdown URL Set when the text exceeded the dataset item size: the full Markdown is in the run's key-value store; markdown holds the first 1 MB. |
text | string | null | Plain text All returned pages as plain text, pages separated by a form feed (\f). |
textUrl | string | null | Full text URL |
extraPagesCharged | integer | null | Extra pages charged pdf-page events charged (pages beyond 20). |
pages | array | null | Pages [{ pageNumber, markdown, text, charCount, wordCount, hasTextLayer, textQuality (good | sparse | garbled | none), needsOcr, blank, imageCount, width, height }] |
outline | array | null | Outline Bookmarks [{ title, pageNumber, level }] (includeOutline). |
raw | object | null | Raw metadata { info, xmp } (includeRaw). |