Convert to Excel

Convert a document into an Excel file. Send a documentId and, optionally, free-text instructions on what the spreadsheet should contain. DocuPipe lays out a workbook for the document (one sheet per table, with the document's own column headers, plus a Document sheet for values that appear once), extracts the data, and stores the file.

The call returns right away with a conversionId. Poll GET /v3/convert/excel/{conversionId} until status is completed, then download the file from excelUrl.

Costs 2 credits per page, the same as a standard-effort standardization. Laying out the workbook costs nothing extra.

Parameters
  • documentId - The uploaded document to convert.
  • instructions - Optional. What the spreadsheet should contain, for example which tables or columns to keep.
  • pages - Optional list of 0-indexed page numbers to convert. If not provided, the whole document is converted.
  • schemaId - Optional. The schemaId returned by an earlier conversion. Reusing it gives the same sheets and columns for similar files.
Body Params
string
required

The uploaded document to convert.

string

Optional free-text instructions on what the spreadsheet should contain, such as which tables or columns to keep.

pages
array of integers

Optional list of zero-indexed page numbers to convert. If omitted, the whole document is converted.

Pages
string

A schemaId returned by an earlier conversion. Reusing it gives the same sheets and columns for similar files and skips designing a new layout.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json