Uploading...

Credits Per Function

estimated costs are calculated for $ per credit = when buying credits.


Endpoint Description Credits 10,000 credits =
/v1/account/credit/balance Account: Get credit balance 2 2  / call 2
/v1/job/check Background Jobs: Check Status 2 2  / call 2
/v1/barcode/generate Barcode: Generate Barcode Image 7 7  / call 7
/v1/barcode/read/from/url Barcode: Read Barcodes From URL or file 35 35  / page 35
/v1/pdf/documentparser/templates Document Parser Get Templates 14 14  / call 14
/v1/pdf/documentparser/results Document Parser Read Saved Results 11 11  / call 11
/v1/pdf/documentparser Document Parser: extract data using template 42 42  / page 42
/v1/email/extract-attachments Email: Extract attachments from .MSG or .EML 35 35  / page 35
/v1/email/decode Email: extract data from .MSG or .EML 35 35  / page 35
/v1/file/delete File: Delete an uploaded file by url 7 7  / call 7
/v1/file/download/:id File: download file from built-in storage 7 7  / call 7
/v1/file/upload/get-presigned-url File: Generate file upload URL 7 7  / call 7
/v1/file/all File: Get list of all files in the built-in storage 7 7  / call 7
/v1/file/options/:id File: get options for a file in built-in storage 7 7  / call 7
/v1/file/options/:token File: set options for a file in built-in storage 7 7  / call 7
/v1/file/upload/base64 File: Upload File From Base 64 21 21  / call 21
/v1/file/upload/url File: Upload File from URL 11 11  / call 11
/v1/file/upload File: Upload small local file as temporary file 11 11  / call 11
/v1/pdf/security/add PDF: Add security protection to PDF 3 3  / page 3
/v1/pdf/edit/add PDF: Add Text, Images, Fill Fields 21 21  / page 21
/v1/pdf/classifier PDF: Classify document based on rules 42 42  / page 42
/v1/pdf/convert/from/csv PDF: Convert CSV to PDF 21 21  / page 21
/v1/pdf/convert/from/doc PDF: Convert Doc, DocX, RTF, TXT, XPS to PDF 21 21  / page 21
/v1/pdf/convert/from/email PDF: Convert EML and MSG to PDF 56 56  / page 56
/v1/pdf/convert/from/html PDF: Convert HTML to PDF 9 9  / page 9
/v1/pdf/convert/from/image PDF: Convert Images to PDF 9 9  / page 9
/v1/pdf/convert/to/csv PDF: Convert PDF to CSV 28 28  / page 28
/v1/pdf/convert/to/html PDF: Convert PDF to HTML 21 21  / page 21
/v1/pdf/convert/to/json2 PDF: Convert PDF to JSON (clean) 28 28  / page 28
/v1/pdf/convert/to/json PDF: Convert PDF to JSON (old) 28 28  / page 28
/v1/pdf/convert/to/text PDF: Convert PDF to Text (AI powered) 21 21  / page 21
/v1/pdf/convert/to/text-simple PDF: Convert PDF to Text (no layout) 4 4  / page 4
/v1/pdf/convert/to/xls PDF: Convert PDF to XLS 35 35  / page 35
/v1/pdf/convert/to/xlsx PDF: Convert PDF to XLSX 28 28  / page 28
/v1/pdf/convert/to/xml PDF: Convert PDF to XML 35 35  / page 35
/v1/pdf/convert/from/url PDF: Convert URL to PDF 9 9  / page 9
/v1/xls/convert/to/pdf PDF: Convert XLS or XLSX to PDF 21 21  / page 21
/v1/pdf/edit/delete-text PDF: Delete text in PDF 21 21  / page 21
/v1/pdf/find PDF: Find text inside PDF and Images 35 35  / page 35
/v1/pdf/merge2 PDF: Merge Images, Documents, PDF to new PDF 35 35  / page 35
/v1/pdf/merge PDF: Merge PDF 2 2  / page 2
/v1/pdf/optimize PDF: Optimize PDF File Size 21 21  / page 21
/v1/pdf/makesearchable PDF: PDF Scan to Text Searchable PDF 35 35  / page 35
/v1/pdf/makeunsearchable PDF: PDF to Scanned PDF 35 35  / page 35
/v1/pdf/info PDF: Read PDF File Information 7 7  / page 7
/v1/pdf/info/fields PDF: Read PDF Form fields 8 8  / call 8
/v1/pdf/edit/delete-pages PDF: Remove pages from PDF 5 5  / page 5
/v1/pdf/security/remove PDF: Remove protection from PDF 3 3  / page 3
/v1/pdf/convert/to/jpg PDF: Render PDF to JPG 12 12  / page 12
/v1/pdf/convert/to/png PDF: Render PDF to PNG 15 15  / page 15
/v1/pdf/convert/to/tiff PDF: Render PDF to TIFF 28 28  / page 28
/v1/pdf/edit/replace-text PDF: Replace text in PDF 21 21  / page 21
/v1/pdf/edit/replace-text-with-image PDF: Replace text with image in a PDF 77 77  / page 77
/v1/pdf/find_table PDF: return JSON with info about tables 21 21  / page 21
/v1/pdf/split PDF: Split PDF (by page numbers) 2 2  / page 2
/v1/pdf/split2 PDF: Split PDF (by text search) 35 35  / page 35
/v1/pdf/translate PDF: Translate Text Inside PDF 700 700  / page 700
/v1/xls/convert/to/csv XLS: Convert XLS/XLSX to CSV 9 9  / page 9
/v1/xls/convert/to/html XLS: Convert XLS/XLSX to HMTL 9 9  / page 9
/v1/xls/convert/to/json XLS: Convert XLS/XLSX to JSON 15 15  / page 15
/v1/xls/convert/to/txt XLS: Convert XLS/XLSX to TXT 9 9  / page 9
/v1/xls/convert/to/xml XLS: Convert XLS/XLSX to XML 15 15  / page 15
* Estimated number of pages is based on 2 credits per page. If job was created with async mode then it also requires to use job/check function to check final job status. Estimated costs (if any) include no sales, GST, VAT, sales and/or local taxes.
Estimated costs per page are calculated based on the selected subscription plan or credits.

Sync mode (async: false): every call consumes credits = number of pages * credits per page (based on the table below).

Async mode (async: true): first call consumes credits for 1 page + credits for the remaining pages consumed along with job/check + credits for job check calls. Click here to show the detailed examples on credits calculations for both modes.
Check API logs for the details on API calls you've made.

Plugins (UiPath, Integromat, Zapier and others) may consume few more credits during built-in background job checks. For long background jobs you may want to increase the delay for background job checks in plugin settings.

Async mode (async: true in API calls)

This mode is used in Zapier and other plugins (with additional auto calls to job/check). This is the recommended mode, especially for large files that require up to 15 minutes of processing.

Total credits for async job = credits for the very first page + small amount of credits for job/check + credits for the remaining pages (if 2 or more pages were processed).

Example:
  1. The input PDF has 10 pages;
  2. The first call to API consumes credits for 1 single page and returns jobid param. JobId is the unique id of async job created;
  3. Call /job/checkto check the status of this job;
  4. If /job/check returns status equal success then it also consumed credits for the remaining 9 pages + small amount of credits for this job/check call;
  5. If /job/check returned failed then this call will return credits consumed for 1 page on the very first step (you'll see negative credits in API logs);


Sync mode (async=false):

Should be used only for small files (under 100 kb) where it takes just a few seconds to process. Every request is limited to 27 seconds. If it takes more then you need to use async mode.

Total credits for sync job = credits for total processed pages

Example:
  1. The input PDF has 10 pages;
  2. The call to API endpoint is processing file right away and consumes credits required for 10 pages;
  3. If call failed then no credits will be consumed;