Documents

Get job status

Check the status of an async document creation job. Poll this endpoint after receiving a jobId from POST /createDocument with async: true.

Progress values: 10% (queued) → 20% (fetching data) → 30% (processing template) → 40% (generating PDF) → 100% (complete).

get/job/{jobId}

Path parameters

jobIdstring required

The job ID returned from async document creation.

Job status retrieved

jobIdstring

status'waiting' | 'active' | 'completed' | 'failed'

Current job status.

progressinteger

Progress percentage (10 → 20 → 30 → 40 → 100).

createdAtstring date-time

processedOnstring date-time

When processing started.

finishedOnstring date-time

When processing finished.

errorstring

Error message (only present when status is failed).

attemptsinteger

Number of processing attempts.

{
  "result": {
    "message": "success"
  }
}

No recorded changes to this endpoint across all 1 revision of this API.