API Reference

const sdk = new BodygramSDK({
  clientKey: 'YOUR_CLIENT_KEY',        // required
  locale: 'en',                        // required
  container: '#my-container',          // optional: CSS selector or DOM element
  scanShouldIncludeOverlay: true,      // optional: tap overlay for iOS audio fix
});

const { front, side } = await sdk.scan(config);

type ScanConfig = {
  camera?: MediaTrackConstraints;
  silhouette?: 'male' | 'female';
  isDebuggerEnabled?: boolean;
  screensToInclude?: ScreenID[];
  welcomeModal?: 'tap-to-start' | 'how-to-scan' | false;
  isMirrored?: boolean;
  hasHeader?: boolean;
  hasActionsArea?: boolean;
};

// Basic scan
const { front, side } = await sdk.scan();

// With camera constraints
const { front, side } = await sdk.scan({
  camera: {
    width: { ideal: 1920 },
    height: { ideal: 1080 },
    facingMode: 'user',
  },
});

// With silhouette overlay
const { front, side } = await sdk.scan({
  silhouette: 'female',
});

// With both options
const { front, side } = await sdk.scan({
  camera: { facingMode: 'user' },
  silhouette: 'male',
});

<img id="front-image" />
<img id="side-image" />

<script>
  const { front, side } = await sdk.scan();
  document.getElementById('front-image').src = front;
  document.getElementById('side-image').src = side;
</script>

{ front: string; side: string }

try {
  const { front, side } = await sdk.scan(config);
} catch (err) {
  if (err.code === 'SCAN_CLOSED_BY_USER') {
    // user dismissed the scanner
  } else if (err.code === 'SCAN_FAILED') {
    // something went wrong during the scan
  }
}

const supported = await sdk.getBody2FitIsProductSupported({
  brandId,    // string — required
  garmentSKU, // string — required (note: all-caps SKU)
});

if (supported) {
  // safe to show the scan/size UI
}

boolean

const result = await sdk.getBody2FitPhotoEstimation({
  front,   // base64 string — required
  side,    // base64 string — required
  age,     // number, > 0 — required
  gender,  // 'male' | 'female' — required
  height,  // millimeters, 500–2500 — required
  weight,  // grams, 10000–200000 — required
  // optional:
  tightness,
  systemOfMeasurement,
  avatarType,
});

{
  "estimations": {
    "estimationToken": {
      "token": "ESTIMATION_TOKEN"
    },
    "measurements": [
      {
        "estimationType": "BUST_GIRTH",
        "value": "920",
        "unit": "MILLIMETERS"
      }
    ],
    "avatarData": null,
    "input": {
      "preferredSystemOfMeasurement": "METRIC",
      "tightness": 0,
      "inputType": "CAMERA_FLOW"
    }
  }
}

const result = await sdk.getBody2FitStatsEstimation({
  age,     // number, > 0 — required
  gender,  // 'male' | 'female' — required
  height,  // millimeters, 500–2500 — required
  weight,  // grams, 10000–200000 — required
  // optional:
  tightness,
  systemOfMeasurement,
  avatarType,
});

{
  "estimations": {
    "estimationToken": { "token": "ESTIMATION_TOKEN" },
    "measurements": [...],
    "avatarData": null,
    "input": {
      "preferredSystemOfMeasurement": "METRIC",
      "tightness": 0,
      "inputType": "MANUAL_STATS"
    }
  }
}

const result = await sdk.getBody2FitTokenEstimation({
  estimationToken,  // string — required
});

const result = await sdk.getBody2FitSizeRecommendation({
  estimationToken,  // string — required
  productInfo: [
    { brandId: 'BRAND_ID', garmentSku: 'GARMENT_SKU' },
    // additional products...
  ],
});

[
  {
    "recommendation": {
      "recommendedSize": "M"
    }
  },
  {
    "recommendation": {
      "recommendedSize": "L"
    }
  }
]

const result = await sdk.getBody2FitSizeFitting({
  estimationToken,  // string — required
  productInfo: [
    { brandId: 'BRAND_ID', garmentSKU: 'GARMENT_SKU' },
  ],
});

[
  {
    "result": {
      "estimationToken": { "token": "ESTIMATION_TOKEN" },
      "sizes": [
        {
          "size": { "index": 0, "name": "0" },
          "recommendationRank": 9,
          "fittingPoints": [
            { "fittingPoint": "BUST_GIRTH", "tightness": 0 }
          ],
          "tightness": 0,
          "neutralRecommendationRank": 9
        }
      ],
      "sizeGroups": []
    }
  }
]

const { token } = await serverSdk.getBodygramScannerPlatformScanToken({
  apiKey: process.env.BODYGRAM_API_KEY,  // server-side env var
  scope: [
    'api.platform.bodygram.com/scans:create',
    'api.platform.bodygram.com/scans:read',
  ],
});

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

const result = await sdk.getBodygramScannerPlatformPhotoEstimation({
  token,    // string — required (from getBodygramScannerPlatformScanToken)
  front,    // base64 string — required (from sdk.scan())
  side,     // base64 string — required (from sdk.scan())
  age,      // number — required, years
  gender,   // 'male' | 'female' — required
  height,   // number — required, millimeters
  weight,   // number — required, grams
});

{
  "entry": {
    "id": "scan_abc123",
    "status": "success",
    "input": {
      "photoScan": {
        "age": 25,
        "gender": "male",
        "height": 1800,
        "weight": 70000
      }
    },
    "measurements": [
      { "name": "bustGirth",  "unit": "mm", "value": 895 },
      { "name": "waistGirth", "unit": "mm", "value": 762 },
      { "name": "hipGirth",   "unit": "mm", "value": 905 }
    ],
    "bodyComposition": {
      "bodyFatPercentage": 18.5,
      "skeletalMuscleMass": 32.1
    },
    "avatar": {
      "data": "base64-encoded-avatar-data...",
      "format": "glb",
      "type": "UPPER_BODY"
    },
    "posture": {
      "front": {},
      "right": {}
    }
  }
}

const result = await sdk.getBodygramScannerPlatformStatsEstimation({
  token,    // string — required (from getBodygramScannerPlatformScanToken)
  age,      // number — required, years
  gender,   // 'male' | 'female' — required
  height,   // number — required, millimeters
  weight,   // number — required, grams
});

{
  "entry": {
    "id": "scan_abc123",
    "status": "success",
    "input": {
      "statsEstimations": {
        "age": 25,
        "gender": "male",
        "height": 1800,
        "weight": 70000
      }
    },
    "measurements": [
      { "name": "bustGirth",  "unit": "mm", "value": 895 },
      { "name": "waistGirth", "unit": "mm", "value": 762 },
      { "name": "hipGirth",   "unit": "mm", "value": 905 }
    ],
    "bodyComposition": null,
    "avatar": {
      "data": "base64-encoded-avatar-data...",
      "format": "obj",
      "type": "highResolution"
    },
    "posture": null
  }
}

type PlatformMeasurement = {
  name: string;   // camelCase measurement key — see table below
  unit: string;   // unit string — typically "mm"
  value: number;  // integer value in the reported unit
};

const { measurements } = result.entry;

// Look up a single measurement by name
const bust = measurements.find(m => m.name === 'bustGirth');
const bustCm = bust ? bust.value / 10 : null;

// Build a lookup map keyed by measurement name
const byName = Object.fromEntries(measurements.map(m => [m.name, m]));
const waistCm = byName.waistGirth.value / 10;

{
  data: string;   // base64-encoded avatar data
  format: string; // file format (e.g. "glb")
  type: string;   // avatar type (e.g. "UPPER_BODY", "FULL_BODY")
}

{
  front: FrontPose;
  right: RightPose;
}

type FrontPose = {
  angles: Array<{
    name: 'ear' | 'shoulder' | 'topHip' | 'foot';
    unit: 'degrees';
    value: number;          // counterclockwise angle from horizontal
  }>;
  lines: Array<{
    name: 'ear' | 'shoulder' | 'topHip' | 'foot';
    points: Array<{ x: number; y: number }>; // exactly 2 points (line segment)
  }>;
};

{
  "angles": [
    { "name": "ear",      "unit": "degrees", "value": -0.59860957 },
    { "name": "foot",     "unit": "degrees", "value": -2.0101578 },
    { "name": "shoulder", "unit": "degrees", "value": -0.23841834 },
    { "name": "topHip",   "unit": "degrees", "value": -1.3451012 }
  ],
  "lines": [
    {
      "name": "topHip",
      "points": [
        { "x": 710.16583, "y": 940.7551 },
        { "x": 456.1496,  "y": 934.7906 }
      ]
    },
    {
      "name": "ear",
      "points": [
        { "x": 654, "y": 381 },
        { "x": 519, "y": 380 }
      ]
    },
    {
      "name": "foot",
      "points": [
        { "x": 735.14667, "y": 1717.625 },
        { "x": 414.76804, "y": 1706.3802 }
      ]
    },
    {
      "name": "shoulder",
      "points": [
        { "x": 738.6984, "y": 537.90106 },
        { "x": 433.4781, "y": 536.631 }
      ]
    }
  ]
}

type RightPose = {
  angles: Array<{
    name: 'bodyLine' | 'backWaistLine';
    unit: 'degrees';
    angles: number[];        // bodyLine: 4 values, backWaistLine: 3 values
  }>;
  lines: Array<{
    name: 'bodyLine' | 'backWaistLine';
    points: Array<{ x: number; y: number }>; // bodyLine: 5 points, backWaistLine: 4 points
  }>;
};

{
  "angles": [
    {
      "name": "backWaistLine",
      "unit": "degrees",
      "angles": [21.443363, 9.388262, -4.5393705]
    },
    {
      "name": "bodyLine",
      "unit": "degrees",
      "angles": [6.476125, 1.875514, -7.529927, 21.864304]
    }
  ],
  "lines": [
    {
      "name": "backWaistLine",
      "points": [
        { "x": 549.01276, "y": 890.2904 },
        { "x": 567.0013,  "y": 844.4911 },
        { "x": 572.44586, "y": 811.5611 },
        { "x": 565.02185, "y": 718.0516 }
      ]
    },
    {
      "name": "bodyLine",
      "points": [
        { "x": 607, "y": 1770 },
        { "x": 649, "y": 1400 },
        { "x": 662, "y": 1003 },
        { "x": 593, "y": 481 },
        { "x": 656, "y": 324 }
      ]
    }
  ]
}