ADadaptionlabs
Dataset

Estimate credit cost for document preprocessing

Changed on

Quotes the credits that extracting a document dataset (pdf, docx, pptx, xlsx, html, or a zip of them) will reserve, from the page count of each document. Pass the same pages_to_process or documents_to_process you intend to launch with. Page counting runs in the background after upload, so isFinal: false means the quote is still partial — poll until it is true. Start extraction with POST /datasets/{dataset_id}/launch-preprocessing.

get/api/v1/datasets/{dataset_id}/preprocessing-credits

Request

Path parameters

dataset_idstring required

Query parameters

pages_to_processnumber

Maximum number of pages to process. Documents are included until this budget is reached. If omitted, all pages are processed.

documents_to_processnumber

Maximum number of documents to process. If omitted, all documents are processed.

Response

availableCreditsnumber required

User's total available credits (team balance)

extractionCostnumber required

Estimated or actual credit cost for document extraction

totalPagesnumber required

Total pages across all documents (sum of page counts)

totalDocumentsnumber required

Total documents in the dataset

completedDocumentsnumber required

Number of documents with completed extraction (page counts known)

isFinalboolean required

Whether the cost is final (all extractions complete) or an estimate

Changes