A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Box Doc Gen template (Base)

A base representation of a Box Doc Gen template, used when nested within another resource.

Standard
Base

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

file object

Enable the file to generate a document from.

file.id string

example42037322

ID of the object.

file.type string

examplefile

The value will always be file.

Value is always file

Response Example

{
  "file": {
    "id": "42037322",
    "type": "file"
  }
}