Developer Hub

DocuShell API Docs

DocuShell gives developers, freelancers, and businesses one async API surface for parsing PDFs, rendering documents, capturing webpages, compressing files, and converting PDFs to Word.

Overview

View as Markdown

Start hereAuthentication, idempotency, polling, downloads, and common errors.Flagship referenceStructured JSON, bounding boxes, Markdown, HTML, text, annotated PDF, and batch parse workflows.Resume ParseATS-focused resume extraction with candidate, contact, sections, skills, and confidence fields.

Base URL

https://api.docushell.com/api

Use this as the API client base, then call /v1/... routes from your server or automation.

Auth

Bearer + Idempotency-Key

Bearer authentication is required. Idempotency is optional but recommended for every submit call.

Job flow

queued -> processing -> done

Submit work, poll /v1/jobs/:jobId, then stream artifacts or files from the shared download route.

Section

Endpoint Inventory

The complete public API surface. Every route uses the same auth and the same queued job flow.

Method	Path	Purpose
POST	`/v1/parse`	Queue one PDF parse job with JSON, Markdown, HTML, text, and annotated PDF artifacts.
POST	`/v1/parse/batch`	Accept an async batch of PDFs with shared parse options, required idempotency, per-file artifacts, and terminal batch status.
GET	`/v1/parse/batch/:batchId`	Poll parse batch status, per-file statuses, usage, expiry, webhook delivery state, and artifact links.
GET	`/v1/parse/batch/:batchId/download`	Generate and stream a ZIP containing completed file artifacts for the batch.
GET	`/v1/parse/batch/:batchId/files/:fileId/download?format=json\|markdown\|html\|text\|annotated_pdf\|markdown_with_html\|markdown_with_images\|tagged_pdf`	Download one requested artifact for one completed file in a batch.
POST	`/v1/resume/parse`	Queue ATS-focused resume parsing with candidate, contact, section, skills, keyword, confidence, and warning fields.
POST	`/v1/markdown-to-pdf`	Render Markdown into a PDF.
POST	`/v1/url/render`	Capture a public webpage as a PDF.
POST	`/v1/pdf/compress`	Compress one or more uploaded PDFs.
POST	`/v1/pdf/to-word`	Convert a PDF into a DOCX file.
GET	`/v1/jobs/:jobId`	Poll a queued job until it reaches a terminal state.
GET	`/v1/jobs/:jobId/download`	Download the final file for non-parse jobs.
GET	`/v1/jobs/:jobId/download?format=json\|markdown\|html\|text\|annotated_pdf\|markdown_with_html\|markdown_with_images\|tagged_pdf`	Download parse artifacts directly.

Section

Credit Costs

Charged on submit. Failed validation, auth failures, and rate-limited requests cost nothing.

Endpoint	Credits
POST /v1/parse	`max(10, pages)` — 1 per page, minimum 10
POST /v1/parse/batch	`max(10, selected_pages)` per file, estimated only
POST /v1/resume/parse	15 flat
POST /v1/markdown-to-pdf	5 flat
POST /v1/url/render	25 flat
POST /v1/pdf/compress	5 up to 50 MB, 10 above
POST /v1/pdf/to-word	`max(20, pages × 2)`