Hosted Quick Start
Run your first V2 render against the hosted API in under 5 minutes. The hosted runtime adds preflight findings, durable render jobs, brand packs, visual diff, and approvals on top of the same documents you'd render locally.
1. Get an API key
Request access at paperjsx.com/get-key, sign in, and create an API key from the dashboard. Free access includes 5 hosted evaluation renders per month.
2. Preflight a deck
curl -X POST https://api.paperjsx.com/api/v2/preflight \
-H "Authorization: Bearer pj_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"sourceSchema": "protocol_v2",
"preflightPolicy": { "autoFix": "suggest_only" },
"document": {
"version": "2.0",
"title": "My First Deck",
"accentColor": "#2563EB",
"slides": [
{
"slideType": "title-body",
"title": "Hello, PaperJSX!",
"subtitle": "Generated through the V2 runtime",
"body": [
"Semantic specs are the default public input format.",
"Preflight returns stable findings and a deck score before render."
]
}
]
}
}'
Preflight responds with data.job_id, data.job_url, data.quality_report, data.policyResult, and data.brand_compliance (when a brand pack is attached).
3. Queue a render
curl -X POST https://api.paperjsx.com/api/v2/render \
-H "Authorization: Bearer pj_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"sourceSchema": "protocol_v2",
"mode": "async",
"approvalRequired": true,
"preflightPolicy": {
"renderIfScoreAbove": 70,
"autoFix": "suggest_only"
},
"document": {
"version": "2.0",
"title": "My First Deck",
"slides": [
{ "slideType": "title-body", "title": "Hello, PaperJSX!" }
]
}
}'
Poll GET /api/v2/jobs/:id for status, artifacts, approval state, and diff metadata.
4. Optional brand pack
Upload a .pptx or .potx template to POST /api/v2/brand-packs, then pass brandPackId or brandPackVersionId to preflight and render so findings and layout mapping become brand-aware.
Next Steps
- Full endpoint reference: API Reference
- Migrating from the legacy V1 runtime: Migrate V1 → V2
- Want to self-host instead? Use
@paperjsx/json-to-pptx-pro— see PPTX.