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.

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.

exclude[]

string

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/pdf

application/json

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.