Gateway
Public API Gateway
One base URL and one auth model for the whole API. The gateway authenticates, rate-limits, and validates each request, then routes it to the service that does the work.
Gateway
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
Request And Response Formats
| Topic | Value | Notes |
|---|---|---|
| Request formats | JSON and multipart/form-data | JSON for Markdown and URL rendering; multipart for file uploads. |
| Response format | JSON | Queued submits return job_id, request_id, and status/download links. |
| File retention | Ephemeral | Uploaded and generated files are swept within one hour; downloaded files are deleted after streaming. |
Section
Health Check
The one unauthenticated route. Everything else requires bearer auth.
Health check
bash
curl "https://api.docushell.com/v1/health"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.