Sign in

v2

latestOpenAPI 3.0.12026-07-266846393.5 KB
Extraction

Parse Document

This API method extracts data from documents based on a document parser extraction template. With this API method, you can extract data from custom areas by searching form fields, tables, multiple pages, and more.

post/v1/pdf/documentparser

Request body

filestring path to a local file

The path to the local file to be uploaded.

urlstring uri required

URL to the source file url attribute.

templateidnumber

Set ID of HTML template to be used. View and manage your templates at HTML to PDF Templates.

templatestring

The raw format of the document parser template to be used directly. see Template

inlineboolean

Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated.

outputformat'JSON' | 'YAML' | 'XML' | 'CSV'

Format of output File. Valid values: JSON, YAML, XML, CSV.

generatecsvheadersboolean
namestring

File name for generated output.

pagesstring

Page indices/ranges (0-based). Items are comma-separated. Each item is one of: N (e.g., 0), N-M (e.g., 3-7), N- (open-ended, e.g., 10-), or !N (reverse index; !0 is last page, !1 is second-to-last). Whitespace is allowed. If not specified, the default configuration processes all pages.

asyncboolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks

passwordstring

Password for the PDF file.

expirationnumber

Sets the expiration time for the output link, in minutes. After this period, generated output file(s) are automatically deleted from PDF.co Temporary Files Storage. The maximum allowed duration depends on your subscription plan. For permanent storage of input files (e.g., reusable images, PDF templates, documents), use PDF.co Built‑In Files Storage.

timeoutnumber

Timeout for output links in seconds

httpusernamestring

HTTP auth user name if required to access source URL.

httppasswordstring

HTTP auth password if required to access source URL.

Example request

{
  "pages": "0,2,5-10, !0, !5-!2"
}

Response

Success.

statusstring

Status of the API response.

messagestring

Descriptive message for the response status.

urlstring uri

URL to the output file.

jobIdstring

Unique identifier for the job.

creditsinteger

Credits used for this operation.

remainingCreditsinteger

Credits remaining after this operation.

durationinteger

Time taken to complete the request, in milliseconds.

Example response

{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}