Request a short-lived, presigned URL for uploading a PDF or image, for use with AWB Data Extraction.

post/ai/uploads

Request

  • Base URL
    https://api.cargoai.co/solutions
  • URL
    https://api.cargoai.co/solutions/ai/uploads
  • Auth
    API key in header x-api-key

Headers

x-api-keystring required

API Key

Request body

emailstring required

Requester email address

contentType'application/pdf' | 'image/jpeg' | 'image/png' required

Media type of the file to upload.

filenamestring required

Name of the file being uploaded

Response

uploadUrlstring

Presigned S3 URL to upload the file to, via PUT

s3Urlstring

The s3:// URI to reference when calling AWB Data Extraction, once the upload is complete

expiresIninteger

Seconds until uploadUrl expires (3600 = 1 hour)

expiresAtstring

Timestamp (ISO 8601) of when uploadUrl expires

Changes