Skip to content
nexdoc.design Docs

Export and publish API

Export a job as HTML ZIP or print-ready PDF, and optionally publish a public NexDoc Design URL.

Scopes: export uses jobs:read; publish/unpublish use jobs:rw.

Omit run_id to target the latest completed run.

POST/v1/jobs/{job_id}/export

code
{ "format": "pdf", "run_id": null }

format is html (ZIP of the site) or pdf. Prefer pdf for print, slides, cards, resumes, and invoices; html for landing-page, portfolio, link-in-bio, email-newsletter, and dashboard.

code
{
  "job_id": "job_...",
  "format": "pdf",
  "run_id": "run_...",
  "commit_hash": "...",
  "download_url": "https://...",
  "expires_at": "..."
}

download_url expires in about one hour. Download promptly.

POST/v1/jobs/{job_id}/publish

Publish to a public URL only when you want the design live. Preview and download do not require it.

code
{ "run_id": null }
code
{
  "public_url": "https://...",
  "run_id": "run_...",
  "commit_hash": "..."
}

POST/v1/jobs/{job_id}/unpublish

code
{ "job_id": "job_...", "unpublished": true }