Skip to content
Glossary
- API key: The secret that authenticates your calls, sent as
Authorization: Bearer <key>. Keys start with ds_live_, are shown once when created and can be revoked at any time.
- Asynchronous mode: Sending
mode=async makes the API answer at once with a job; the conversion runs in the background. See Asynchronous jobs.
- Batch: A request that converts several files, or a ZIP archive, at once with
POST /v1/convert/batch. See Batch and ZIP.
input_truncated: true when a document's text was longer than the 25,000 characters sent to the AI extractor, so the text beyond that limit was not read.
- Job: The record of an asynchronous conversion, with a status (
pending, processing, completed, failed) and, once done, its result for 24 hours.
- OCR: Optical character recognition: reading the text of a scan or a photo. DocSlice applies it automatically and reports
ocr_applied: true.
- Page: The unit of your quota. Every page of a converted document counts, including pages read with OCR.
- Quota: The number of pages you can convert per calendar month (UTC). It starts again on the first of the month.
- Rate limit: The number of conversion requests per minute you can make. Over it, the API answers
429 with Retry-After.
- Schema: A JSON Schema you send with
format=json to say which fields you want. The answer then follows it. See Schema extraction.
- Synchronous mode: The default: the request waits and the answer holds the result.
- Webhook: An HTTP call DocSlice makes to your server when an asynchronous job ends. See Webhooks.
- Zero retention: Uploaded files are deleted right after processing and results are kept only 24 hours. See Privacy and data retention.