Document PDFs

Download PDF versions of driver documents using a two-step asynchronous job pattern.

Creating a PDF version of a driver document is an asynchronous process. There are two steps:

1. Trigger PDF creation job

   The following triggers the creation of a PDF version of the document with documentId 1654973_1593713510968:

   curl --request POST 'https://api.samsara.com/fleet/documents/pdfs' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer YOUR_API_TOKEN' \
   --data-raw '{
       "documentId": "1654973_1593713510968"
   }'
   

   The response will contain the id of the PDF job as well as the original documentId:

   {
       "data": {
           "id": "4407d645-93a2-4a4d-8702-468cb5f9bf34",
           "documentId": "1654973_1593713510968"
       }
   }
   
2. Check job status and download PDF

   Once you’ve triggered the PDF job, you can check its status and (if completed) download the PDF.

   You supply the id of the PDF job from step 1 as a URL parameter to the GET request:

   curl --request GET 'https://api.samsara.com/fleet/documents/pdfs/4407d645-93a2-4a4d-8702-468cb5f9bf34' \
   --header 'Authorization: Bearer YOUR_API_TOKEN'
   

   {
       "data": {
           "id": "4407d645-93a2-4a4d-8702-468cb5f9bf34",
           "documentId": "1654973_1593713510968",
           "jobStatus": "completed",
           "requestedAtTime": "2020-07-02T18:34:06.456Z",
           "completedAtTime": "2020-07-02T18:34:10.176Z",
           "downloadDocumentPdfUrl": "https://samsara-driver-document-pdfs.s3.us-west-2.amazonaws.com/..."
       }
   }
   

   The response will contain the jobStatus of the PDF job. This can be completed, requested, or processing. If the job is not completed, it is recommended that you wait 5 seconds and try again.

   Once the job has been completed, the downloadDocumentPdfUrl will provide a URL to the PDF document that expires after 7 days. If the URL has expired, you may request creation of the PDF again as described in step 1.