CAcargoai

AWB Data Extraction

Changed on

AI Powered - Transform AWB image data into structured AWB information and remove manual data entry from your AWB transmission process.

post/ai/awb

Request

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

Headers

x-api-keystring required

API Key

Request body

emailstring required

Requester email address

datastring required

Base64 encoded image for IMAGE. When type is PDF, data is the s3Url returned by POST /solutions/ai/uploads (an s3://… URI), not a base64 payload.

type'IMAGE' | 'PDF' required

media type (IMAGE, PDF)

Response

200

awb_numberstring
confidenceScorenumber

Example response

{
  "awb": {
    "shipper": {
      "name": "Shipper's name",
      "account_number": "0000",
      "phone": "+00000000000",
      "email": "Shipper's email",
      "address": {
        "line1": "1462 Test street",
        "city": {
          "name": "Paris"
        },
        "postal_code": "00000",
        "country": {
          "code": "FR",
          "name": "France"
        }
      }
    },
    "consignee": {
      "name": "Consignee's name",
      "phone": "+00000000000",
      "address": {
        "line1": "1463 Test road",
        "city": {
          "name": "Singapore"
        },
        "postal_code": "0000000",
        "country": {
          "code": "SG",
          "name": "Singapore"
        }
      }
    },
    "routingDetails": [
      {
        "from_airport_code": "CDG",
        "to_airport_code": "AMS",
        "carrier_code": "00",
        "flight_number": "687",
        "flight_date": "2025-08-20"
      }
    ],
    "chargesDeclaration": {
      "currency_code": "EUR",
      "charge_code": "PP",
      "weight_or_valuation": "P",
      "other": "X"
    },
    "rates": [
      {
        "number_of_pieces": 5,
        "gross_weight": {
          "value": 354.1,
          "uom": "K"
        },
        "rate_class_code": "Q",
        "chargeable_weight": 357,
        "rate_or_charge": 4.02,
        "charge_amount": 1435.14,
        "nature_and_quantity_of_goods": "PERSONAL GOODS",
        "dims": [
          {
            "pcs": 1,
            "length": 80,
            "width": 60,
            "height": 40,
            "uom": "CMT"
          }
        ]
      }
    ],
    "execution": {
      "date": "2025-08-20",
      "place": "Paris",
      "shipper_signature": "Shipper's Signature",
      "carrier_signature": "Carrier's Signature"
    },
    "oci": {
      "origin_country_code": "FR"
    },
    "agent": {
      "iata": "0000000",
      "cass": "0000",
      "name": "Agent's name",
      "place": "LYON"
    },
    "handling": {
      "sci": "X"
    }
  },
  "awb_number": "000-00000000",
  "confidenceScore": 0.9
}

Changes