DocuShell
PProduct HuntLaunch offer: reserve 1 month of Pro free before limited slots open.Reserve free Pro

Gateway

Public API Gateway

The gateway gives developers one stable API base URL while DocuShell routes work to dedicated processing services behind the scenes.

Gateway5 min
View as Markdown
Getting startedSubmit a job, poll status, and download the result.Rate LimitsUnderstand the default 10 requests per minute throttle and retry behavior.Parse playgroundRun the Parse playground with a sample PDF or your own API key.

Base URL

https://api.docushell.com/api

Append /v1/... paths for public API calls.

Auth

API Key / JWT bearer

API keys are recommended; JWT support depends on the active deployment.

Default rate

10 req/min

The default limiter is per API key or caller fingerprint unless configured otherwise.

Section

Gateway Overview

The critical integration details in one place.

TopicValueNotes
Base URLhttps://api.docushell.com/apiUse with documented /v1/... routes.
AuthenticationBearer API key; JWT where enabledAttach to every submit, status, and download request.
Rate limit10 requests/minute defaultConfigurable per deployment and enforced before queue handoff.
Request formatsJSON and multipart/form-dataJSON for Markdown and URL rendering; multipart for file uploads.
Response formatJSONQueued submits return job_id, request_id, and status/download links.
File retentionEphemeralUploaded and generated files are swept within one hour and downloaded files are deleted after streaming where applicable.

Section

Gateway Examples

First request

bash

curl -X POST "https://api.docushell.com/api/v1/markdown-to-pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "markdown": "# DocuShell\n\nRendered through the public API.",
    "file_name": "quickstart.md",
    "page_size": "A4"
  }'

Health check

bash

curl "https://api.docushell.com/api/health"
Health checks are for discovery and operations. Public API work still requires bearer auth.

Section

What The Gateway Handles

  • Authentication and request identity.
  • Rate limiting before expensive processing begins.
  • Validation and request normalization before queueing work.
  • Shared job_id, request_id, status polling, and download routes.
  • One-time output streaming while internal services stay private.