Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: DocuQueue System API
description: Convert web pages and raw HTML into beautifully formatted PDF files. Sign up at docuqueue.com to get your API key.
version: 1.0.0
tags:
- name: System
paths:
/api/v1/health:
get:
tags:
- System
summary: Health check
description: Check API health, Redis connectivity, and queue status.
operationId: health_check_api_v1_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResponse'
components:
schemas:
HealthResponse:
properties:
status:
type: string
title: Status
description: Overall service status
redis:
type: string
title: Redis
description: Redis connection status
queue_length:
type: integer
title: Queue Length
description: Number of jobs waiting in queue
type: object
required:
- status
- redis
- queue_length
title: HealthResponse