API Reference
Status ↗︎Log In 🇺🇸 ↗︎Log In 🇬🇧 ↗︎

Export a PDF of an inspection

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

Exactly the same as the matching GET endpoint, but allows for a larger payload, as it's sent in the body instead of the query string.

Path Params
integer
required

The ID of the existing inspection request.

Body Params

Request body for POST /inspections/{inspectionId}/export

boolean
Defaults to false

Whether to perform synchronously (in the request/response cycle) or queue for asynchronous export.\n\n If false (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.\n\n If true, the PDF is queued for asynchronous export and an Operation is returned to track its progress. This is recommended.

exclude
array of strings
Defaults to

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

exclude
filter
object

Filters which photos/videos are included in the PDF. Once specified, the PDF will only be generated based on the specific list of photos that are listed. By default all photos/videos are included. If you don't want to generate a PDF with a specific set of photos/videos, you can omit this property.

include
array of strings
Defaults to

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.

include
string
Defaults to UTC

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 9 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/json

Updated 9 days ago