Skip to main content
API version 2025.0 A standard representation of a Box Doc Gen job.
This resource has a few variations that can be encountered when using the API.The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.
​
id
string
example: 12345The unique identifier that represent a Box Doc Gen job.
​
type
string
example: docgen_jobThe value will always be docgen_job.Value is always docgen_job
​
batch
Box Doc Gen batch (Base)object
Box Doc Gen batch that the job belongs to.
​
output_file
object
The output file of the job. This property is null until the job is completed.
​
output_file_version
object
File version of the output file. This property is null until the job is completed.
​
output_type
string
example: docxType of the generated file.
​
status
string
example: completedStatus of the job.Value is one of submitted,completed,failed,completed_with_error,pending
​
template_file
object
Box Doc Gen template used in the job.
​
template_file_version
object
File version of a template.
{
  "id": "12345",
  "type": "docgen_job",
  "batch": {
    "id": "12345",
    "type": "docgen_batch"
  },
  "output_file": {
    "id": "42037322",
    "type": "file"
  },
  "output_file_version": {
    "id": "12345",
    "type": "file_version"
  },
  "output_type": "docx",
  "status": "completed",
  "template_file": {
    "id": "42037322",
    "type": "file"
  },
  "template_file_version": {
    "id": "12345",
    "type": "file_version"
  }
}