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

Authentication

Authentication

DocuShell uses bearer authentication for every public API route. API keys are the production path today; JWT bearer tokens are documented as a gateway-compatible pattern for future account-scoped integrations.

Authentication4 min
View as Markdown
Public API GatewaySee the base URL, request envelope, response format, and gateway responsibilities.Error CodesReview the auth and permission failures returned by the gateway.

Header

Authorization

Send a bearer credential on every submit, status, and download route.

Primary Method

API Key

Create keys in the DocuShell dashboard and keep them in server-side environments.

Retry Safety

Idempotency-Key

Use a stable key when retrying the same queued job after a timeout.

Section

API Keys

API keys are the recommended production authentication method for DocuShell API clients. Generate them in the dashboard, store them in a secret manager, and attach them as bearer tokens.

Do not ship API keys in browser bundles. DocuShell is browser-based for end users, but API credentials belong in server-side code, workers, CI systems, or trusted automation runtimes.

  • Use Authorization: Bearer YOUR_API_KEY on every route.
  • Rotate exposed keys from the dashboard.
  • Pair submit requests with Idempotency-Key when callers may retry.

Section

Auth Headers

API key header

http

Authorization: Bearer YOUR_API_KEY
Idempotency-Key: job-submit-001

JWT bearer header

http

Authorization: Bearer YOUR_JWT
JWT bearer tokens use the same header shape. Treat them as account-scoped gateway credentials only where your deployment explicitly supports them.

Section

Authentication Methods

MethodStatusUse case
API KeyRecommendedServer-side integrations, workers, automation, and backend services.
JWTGateway-compatible / deployment-dependentSession or account-scoped integrations where the deployment issues JWT bearer tokens.
AnonymousNot supportedPublic docs and health checks can be browsed, but API work requires credentials.

Section

Idempotent Retries

Queued PDF work can be expensive, so submit routes accept Idempotency-Key. If a client times out before receiving the queued response, retry the exact same request with the same idempotency key.

If the payload changes, create a new idempotency key. The gateway returns a conflict when the same key is reused for different work.