Skip to content
nexdoc.design Docs

Jobs API

Create, fetch, list, and delete design jobs — the durable container for every NexDoc generation run.

Scopes: jobs:rw / jobs:read

A job is one design and its history. Reuse the same job_id for every edit. Never create a second job for the same request.

POST/v1/jobs

code
{ "name": "Acme Landing Page" }

201:

code
{
  "job_id": "job_...",
  "name": "Acme Landing Page",
  "current_commit": null,
  "created_at": "2026-09-03T00:00:00Z"
}

GET/v1/jobs

List jobs for the authenticated org (newest first, max 100).

code
{
  "data": [
    {
      "job_id": "job_...",
      "name": "Acme Landing Page",
      "current_commit": "...",
      "total_runs": 3,
      "created_at": "...",
      "viewer_url": "https://..."
    }
  ]
}

GET/v1/jobs/{job_id}

Job detail including viewer_url, total_runs, published_url, published_run_id, published_at, and viewer_expires_at.

DELETE/v1/jobs/{job_id}

Soft-deletes the job and its runs.

code
{ "job_id": "job_...", "deleted": true, "runs_deleted_count": 3 }