API Reference
API Reference

/api/v1/album-media-pdf/generate

post
https://api.portal.scanifly.com/api/v1/album-media-pdf/generate

Generates a PDF from an array of survey media IDs.
The client should generate a UUID and pass it in the request to link the PDF to the request.
The PDF will be generated and stored, and the document will be saved with the UUID and PDF URL.

Body Params
mediaItems
array of objects

Array of media items with their IDs and types, in the order they should appear in the PDF. Either mediaItems or fetchAllAlbumMedia must be provided.

mediaItems
fetchAllAlbumMedia
object

When provided, all media in the specified album will be automatically fetched and included in the PDF instead of requiring explicit mediaItems. Either mediaItems or fetchAllAlbumMedia must be provided.

string
required

UUID generated by the client to link the PDF to the request

string
required

ID of the album

string
required

Title of the album

Responses

400
401
404

Updated about 1 month ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?