Public API Gateway
DocuShell Public API Gateway
This host owns the public API routes, shared job status and download endpoints, health checks, and the internal callback entrypoints used by the underlying processing services.
Gateway
REST
Submit jobs and poll status safely.
Auth
Bearer token
Use API keys for protected routes.
Storage
Ephemeral
Generated files are retained only temporarily.
Live Health
Database
Healthy
Redis
Healthy
Rate limit
Healthy
Gateway Facts
Connection details
Base URL
https://api.docushell.com/api
Rate limit
10 requests per minute per API key or caller fingerprint by default.
Auth
API keys with `Authorization: Bearer YOUR_API_KEY` are the recommended production path. JWT bearer tokens use the same header shape where a deployment explicitly supports them.
Responses
JSON for submit, status, and errors. Completed downloads stream files or parse artifacts.
Endpoint Matrix
Public routes
Async Flow
Submit, poll, download
- 01
Submit a queued job through a `POST /v1/...` route.
- 02
Store `job_id` and `request_id`.
- 03
Poll `GET /v1/jobs/:jobId` until the job becomes `done` or `failed`.
- 04
Stream the finished output from `GET /v1/jobs/:jobId/download` or the parse artifact download variants.
- 05
For parse batches, store `batch_id`, poll `GET /v1/parse/batch/:batchId`, and stream the generated ZIP or per-file artifact downloads.
Trust Model
Operational guarantees
- Base URL for API clients: https://api.docushell.com/api
- Authentication always uses `Authorization: Bearer ...`.
- Default public API rate limiting is 10 requests per minute per API key or caller fingerprint.
- Use `Idempotency-Key` on submit routes when you need retry-safe queued jobs.
- Uploaded and generated files are ephemeral and swept within one hour.
- Browser tabs are for docs discovery and health checks. Real API calls belong in HTTP clients where headers can be attached correctly.
- The gateway normalizes auth, request IDs, polling, and downloads even though the actual work is performed by dedicated backend services.