AI Powered: extract structured data from Air Waybills (image, scan or PDF) and send it on to the FWB&FHL API.
The AWB SCAN API reads an Air Waybill (a photo, a scan or a PDF of a completed AWB) and returns a structured AWB object. That object is shaped so it can be used as the payload of the FWB&FHL API: you go from a paper or PDF AWB to a transmitted electronic message without typing the waybill again.
One document per request. For a PDF, only the first page is read.
Formerly part of the CargoCOPILOT APIAWB extraction used to be part of the CargoCOPILOT API. It is now its own product, listed separately in the CargoCONNECT portal. The endpoints, requests and responses are unchanged: an existing integration keeps working as it is. Shipment extraction stays in the CargoCOPILOT API.
Endpoints
| Endpoint | Call | What it does |
|---|---|---|
| AWB Data Extraction | POST /solutions/ai/awb | Extracts the AWB data from an image (base64) or from a PDF uploaded with the Upload URL endpoint. |
| Upload URL | POST /solutions/ai/uploads | Returns a short-lived URL to upload a PDF, and the reference to pass to AWB Data Extraction. |
To extract a PDF:
- Call Upload URL and upload your PDF to the
uploadUrlit returns. - Call AWB Data Extraction with
type: PDFanddataset to thes3Urlvalue.
To extract an image, call AWB Data Extraction directly with the base64 image.
Credits
The AWB SCAN API needs a paid CargoCONNECT plan. Each call uses credits from your organization's balance:
| Call | Credits |
|---|---|
| AWB Data Extraction, image | 5 |
| AWB Data Extraction, PDF | 8 |
| Upload URL | 0 |
- Errors are not charged, with one exception:
422 INVALID_AWB_DOCUMENT(the document could not be read as an Air Waybill) is charged at a reduced rate, 20% of the cost rounded up: 1 credit for an image, 2 credits for a PDF. The document was read, so check that you send a valid AWB, on the first page for a PDF. 5xxerrors are always free.
See Plans, Credits and API Keys for plans, credit headers and top-ups.
Disclaimer: user responsibility for data accuracyThe API returns the data it extracts from your document. It is your responsibility to check the extracted AWB details before you use them for a transmission. We do not verify or adjust extracted data, and we are not liable for outcomes resulting from incorrect input or unverified extractions.