Export a PDF of an inspection

get

https://vision-api.truepic.{tld}/v3/inspections/{inspectionId}/export

Exactly the same as the matching POST endpoint, but is limited in the amount of data that can be passed in the query string due to the maximum URL length allowed by browsers. Use the POST endpoint to send larger payloads.

Path Params

inspectionId

integer

required

The ID of the existing inspection request.

Query Params

async

boolean

Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.

If 0 (or unspecified), the PDF is exported synchronously and returned in the response. This is the default for backwards-compatibility, but is deprecated in favor of performing asynchronously.

If 1, the PDF is queued for asynchronous export and an Operation is returned to track its progress. This is recommended.

filter

object

Filters which photos/videos are included in the PDF. By default all photos/videos are included and this property is not required.

include[]

array of strings

Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property.

Accepts the legacy inspectionNote alias and the canonical section ids. The only opt-in section is Inspection Notes; the other ids are accepted for forward-compatibility.

include[]

exclude[]

array of strings

Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property.

Accepts the legacy tokens (questions → Inspection Items, thumbnails → no-op, imageDetails, timeline) and the canonical section ids.

exclude[]

showUnansweredItems

boolean

Defaults to true

Whether to include items the customer never submitted (unanswered questions and captures with no upload) in the Inspection Items section. Set to false to hide them.

string

The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC.

captureLocationMaps[]

array of strings

Defaults to outside,within,no_location

Which capture-location maps to render in the Image Details section. Omit to render a map for every capture (the default); provide a subset to limit which captures get a map, or an empty array to render no maps.

outside: captures taken outside the expected address
within: captures taken within the expected address
no_location: captures with no expected address on the inspection

captureLocationMaps[]

Allowed:

highResImages

boolean

Defaults to true

Whether the Image Details section embeds the full-resolution web image variant (up to 1080px) or a smaller PDF-optimized variant.

If true (or unspecified), full-resolution images are embedded.

If false, the PDF-optimized variant is embedded instead, producing a smaller file that exports faster.

1/0 are also accepted and coerced to true/false.

200The PDF was successfully exported synchronously.

202The PDF was successfully queued for asynchronous export.

400The request body couldn't be parsed.

401Authentication failed, or the user/client doesn't have permission to the requested resource.

403The user doesn't have permission to access the requested resource.

404The requested resource couldn't be found.

412A required property or parameter is missing from the request.

500An unexpected error occurred.