ManualHQ REST API
Integrate ManualHQ into your systems. Manage documents, access, and invitations programmatically.
Base URL: https://www.manualhq.app/api/v1
Authentication
All API requests require an API key in the Authorization header.
Create API keys under Settings → API Keys in your manufacturer dashboard.
# Example request curl https://www.manualhq.app/api/v1/documents \ -H "Authorization: Bearer mhq_IhrApiKeyHier"
Important: API keys grant full access to all documents and access grants in your manufacturer account. Treat them like passwords.
Documents
/api/v1/documents
List all documents of the manufacturer.
curl https://www.manualhq.app/api/v1/documents \ -H "Authorization: Bearer mhq_..." # Response 200 { "data": [ { "id": "0195f3c2-7b1a-7e42-9c3d-4a5b6c7d8e9f", "title": "Installationsanleitung v3.2", "page_count": 42, "file_size": 2458624, "downloadable": true, "access_count": 12, "created_at": "2026-03-20T10:30:00+00:00" } ] }
/api/v1/documents/{uuid}
Retrieve document details including chapters.
/api/v1/documents
Upload a PDF document. Multipart/form-data.
curl -X POST https://www.manualhq.app/api/v1/documents \ -H "Authorization: Bearer mhq_..." \ -F "[email protected]" \ -F "title=Installationsanleitung v3.2" \ -F "description=Für Modell XR-500" \ -F "downloadable=1" # Response 201
| Parameter | Type | Required | Description |
|---|---|---|---|
file | File | Yes | PDF file (max 100 MB) |
title | String | No | Title (default: filename) |
description | String | No | Description |
downloadable | Boolean | No | Allow download with watermark |
/api/v1/documents/{uuid}
Delete document and all related access grants.
/api/v1/documents/{uuid}/chapters
List chapters of a document (automatically extracted from PDF bookmarks).
Access
/api/v1/documents/{uuid}/accesses
List all access grants of a document.
/api/v1/documents/{uuid}/accesses
Grant access to a customer. JSON body.
curl -X POST https://www.manualhq.app/api/v1/documents/0195f3c2-7b1a-7e42-9c3d-4a5b6c7d8e9f/accesses \ -H "Authorization: Bearer mhq_..." \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "chapter_id": "0195f3c2-8c2b-7f53-8d4e-5b6c7d8e9f0a", "expires_at": "2026-12-31T23:59:59+00:00" }' # Response 201
| Parameter | Type | Required | Description |
|---|---|---|---|
email | String | Yes | Email of the registered customer |
chapter_id | UUID (String) | No | Chapter ID (empty = full document) |
expires_at | ISO 8601 | No | Expiry date (empty = unlimited) |
/api/v1/documents/{uuid}/accesses/{accessUuid}
Revoke access.
Invitations
/api/v1/invitations
List all invitations.
/api/v1/invitations
Invite a customer via email. Automatically creates an invitation and sends the email.
curl -X POST https://www.manualhq.app/api/v1/invitations \ -H "Authorization: Bearer mhq_..." \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "document_id": "0195f3c2-7b1a-7e42-9c3d-4a5b6c7d8e9f", "send_email": true }' # Response 201 { "data": { "id": 42, "email": "[email protected]", "status": "pending", "invite_url": "https://www.manualhq.app/invite/abc123...", "expires_at": "2026-03-27T10:30:00+00:00" } }
| Parameter | Type | Required | Description |
|---|---|---|---|
email | String | Yes | Email of the customer to invite |
document_id | UUID (String) | No | Document ID for automatic access grant |
access_expires_at | ISO 8601 | No | Access expiry date |
send_email | Boolean | No | Send email (default: true) |
Error Handling
Errors are returned as JSON with an error and message field.
{
"error": "authentication_failed",
"message": "Invalid API key."
}
| HTTP Code | Meaning |
|---|---|
200 | Success |
201 | Created |
204 | Deleted (no body) |
400 | Bad Request |
401 | Not Authenticated |
403 | Forbidden / Limit reached |
404 | Not Found |
429 | Rate Limit Exceeded |
Rate Limits & Plans
API access is available from the Pro plan. Exceeding the limit returns a 429 response.
| Plan | API Access | Rate Limit |
|---|---|---|
| Starter (29 €/mo) | No access | — |
| Pro (79 €/mo) | Available | 100 Requests/min |
| Business (199 €/mo) | Available | 1.000 Requests/min |