{ "service": "humanform-workers", "version": "0.1.0", "environment": "development", "description": "Anthropometric prediction API. Authenticated /v1 routes charge one credit per successful prediction (or free-tier call when credits are zero).", "authentication": { "type": "bearer", "header": "Authorization: Bearer ", "notes": [ "All /v1/* routes require a valid API key.", "Remote MCP at /mcp requires the same Bearer API key.", "GET /health and GET / do not require authentication." ] }, "mcp": { "path": "/mcp", "transport": "streamable-http", "auth": "Authorization: Bearer ", "description": "Remote Model Context Protocol endpoint. Tools mirror /v1/* and consume the same credits. Use get_catalog for enums and schemas.", "tools": [ "get_catalog", "predict", "predict_range", "predict_compare", "percentile_lookup", "connected_dimension" ] }, "defaults": { "country": "US", "unit": "mm", "clothing": "nude", "posture": "standing_erect" }, "composition": "final_mm = (us_prediction_mm × country_ratio) + clothing_offset_mm + posture_offset_mm", "billing": { "predict": "1 credit (or 1 free-tier call) per successful request", "predict/range": "1 credit (or free-tier call) per returned percentile value", "predict/compare": "1 credit (or free-tier call) per returned country value", "percentile-lookup": "1 credit (or 1 free-tier call) per successful request", "connected-dimension": "1 credit (or 1 free-tier call) per successful request", "note": "Failed predictions (validation / model errors) do not consume credits." }, "enums": { "genders": [ "Male", "Female" ], "units": [ "mm", "cm", "in" ], "countries": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ], "measurements": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ] }, "endpoints": [ { "method": "GET", "path": "/", "auth": false, "description": "This API catalog (schema, instructions, endpoints)." }, { "method": "GET", "path": "/health", "auth": false, "description": "Liveness check.", "response": { "ok": true, "service": "humanform-workers", "env": "preview|production" } }, { "method": "GET|POST", "path": "/mcp", "auth": true, "description": "Remote MCP (Streamable HTTP). Authenticate with the same Bearer API key as /v1. Tools: get_catalog, predict, predict_range, predict_compare, percentile_lookup, connected_dimension. Tool calls charge credits like the matching /v1 routes." }, { "method": "POST", "path": "/v1/predict", "auth": true, "description": "Predict a single measurement at one percentile for one country.", "request": { "measurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "gender": { "type": "string", "enum": [ "Male", "Female" ] }, "age": { "type": "number", "minimum": 0, "maximum": 120 }, "unit": { "type": "string", "enum": [ "mm", "cm", "in" ], "default": "mm" }, "clothing": { "type": "string", "optional": true, "default": "nude", "description": "Clothing profile id from adjustments (e.g. nude, light, shoes, light_shoes, winter). Unknown ids return 400." }, "posture": { "type": "string", "optional": true, "default": "standing_erect", "description": "Posture profile id from adjustments (e.g. standing_erect, standing_relaxed, sitting). Unknown ids return 400." }, "percentile": { "type": "number", "minimum": 1, "maximum": 99 }, "country": { "type": "string", "enum": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ], "default": "US" } }, "example": { "measurement": "Stature", "gender": "Male", "age": 30, "percentile": 50, "country": "UK", "unit": "mm", "clothing": "light_shoes", "posture": "standing_relaxed" }, "response": { "measurement": "string", "gender": "Male|Female", "country": "string", "clothing": "string", "posture": "string", "value": "number", "unit": "mm|cm|in", "source": "modeled|derived", "remaining_free_calls": "number (when billed via free tier)" } }, { "method": "POST", "path": "/v1/predict/range", "auth": true, "description": "Predict one measurement for one country across multiple percentiles.", "request": { "measurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "gender": { "type": "string", "enum": [ "Male", "Female" ] }, "age": { "type": "number", "minimum": 0, "maximum": 120 }, "unit": { "type": "string", "enum": [ "mm", "cm", "in" ], "default": "mm" }, "clothing": { "type": "string", "optional": true, "default": "nude", "description": "Clothing profile id from adjustments (e.g. nude, light, shoes, light_shoes, winter). Unknown ids return 400." }, "posture": { "type": "string", "optional": true, "default": "standing_erect", "description": "Posture profile id from adjustments (e.g. standing_erect, standing_relaxed, sitting). Unknown ids return 400." }, "country": { "type": "string", "enum": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ], "default": "US" }, "percentiles": { "type": "array", "items": { "type": "number", "minimum": 1, "maximum": 99 }, "minItems": 1, "maxItems": 20, "uniqueItems": true } }, "example": { "measurement": "Stature", "gender": "Female", "age": 35, "country": "US", "unit": "mm", "percentiles": [ 5, 50, 95 ] }, "response": { "measurement": "string", "gender": "Male|Female", "country": "string", "clothing": "string", "posture": "string", "unit": "mm|cm|in", "source": "modeled|derived", "values": [ { "percentile": "number", "value": "number" } ], "remaining_free_calls": "number (when billed via free tier)" } }, { "method": "POST", "path": "/v1/predict/compare", "auth": true, "description": "Predict one measurement at one percentile across multiple countries.", "request": { "measurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "gender": { "type": "string", "enum": [ "Male", "Female" ] }, "age": { "type": "number", "minimum": 0, "maximum": 120 }, "unit": { "type": "string", "enum": [ "mm", "cm", "in" ], "default": "mm" }, "clothing": { "type": "string", "optional": true, "default": "nude", "description": "Clothing profile id from adjustments (e.g. nude, light, shoes, light_shoes, winter). Unknown ids return 400." }, "posture": { "type": "string", "optional": true, "default": "standing_erect", "description": "Posture profile id from adjustments (e.g. standing_erect, standing_relaxed, sitting). Unknown ids return 400." }, "percentile": { "type": "number", "minimum": 1, "maximum": 99 }, "countries": { "type": "array", "items": { "type": "string", "enum": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ] }, "minItems": 1, "maxItems": 10, "uniqueItems": true } }, "example": { "measurement": "Stature", "gender": "Male", "age": 30, "percentile": 50, "unit": "mm", "countries": [ "US", "UK", "JP" ] }, "response": { "measurement": "string", "gender": "Male|Female", "percentile": "number", "clothing": "string", "posture": "string", "unit": "mm|cm|in", "source": "modeled|derived", "values": [ { "country": "string", "value": "number" } ], "remaining_free_calls": "number (when billed via free tier)" } }, { "method": "POST", "path": "/v1/percentile-lookup", "auth": true, "description": "Inverse of predict: given a measured value, return the matching percentile.", "request": { "measurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "gender": { "type": "string", "enum": [ "Male", "Female" ] }, "age": { "type": "number", "minimum": 0, "maximum": 120 }, "unit": { "type": "string", "enum": [ "mm", "cm", "in" ], "default": "mm" }, "clothing": { "type": "string", "optional": true, "default": "nude", "description": "Clothing profile id from adjustments (e.g. nude, light, shoes, light_shoes, winter). Unknown ids return 400." }, "posture": { "type": "string", "optional": true, "default": "standing_erect", "description": "Posture profile id from adjustments (e.g. standing_erect, standing_relaxed, sitting). Unknown ids return 400." }, "country": { "type": "string", "enum": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ], "default": "US" }, "value": { "type": "number", "exclusiveMinimum": 0 } }, "example": { "measurement": "Stature", "gender": "Male", "age": 30, "country": "US", "unit": "mm", "value": 1750 }, "response": { "measurement": "string", "gender": "Male|Female", "country": "string", "clothing": "string", "posture": "string", "value": "number", "unit": "mm|cm|in", "percentile": "number", "remaining_free_calls": "number (when billed via free tier)" } }, { "method": "POST", "path": "/v1/connected-dimension", "auth": true, "description": "Given an anchor measurement at a percentile, return the conditional range of a linked measurement for a target accommodation level.", "request": { "anchorMeasurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "anchorPercentile": { "type": "number", "minimum": 1, "maximum": 99 }, "linkedMeasurement": { "type": "string", "enum": [ "AbdominalDepth", "ArmRestHeight", "BackOfHeadToChin", "BackOfHeadToEye", "BackOfHeadToLip", "BackOfHeadToNoseTip", "BackOfHeadToSelion", "BackOfHeadToTragion", "Biocular", "BitragionWidth", "ButtockKneeLength", "ButtockPoplitealLength", "ChestBreadth", "ChestDepth", "CrotchHeight", "DorsomLength", "EarLength", "ElbowFingertipLength", "ElbowHeight", "ElbowSpan", "EyeBodyCentreDistance", "EyeHeight", "EyeScalpDistance", "EyeToSeat", "EyeToTableDistance", "FingertipHeight", "FootBreadth", "FootLength", "ForearmLength", "ForeheadWidth", "GripWidth", "HairLine", "HandBreadth", "HandLength", "HeadBreadth", "HeadGirth", "HeadLength", "HeadToGlabella", "HeadToNoseTip", "HeadToTragion", "HighCounterHeight", "HipBreadth", "HipHeight", "IndexFingerLength", "IndexFingerWidthPip", "IndexFingerWidthTip", "KneeHeight", "KnuckleHeight", "LegLength", "LegRoom", "LipLength", "LittleFingerLength", "LittleFingerWidthPip", "LittleFingerWidthTip", "LowCounterHeight", "MaximumSeatLength", "MaximumTableHeight", "MiddleFingerLength", "MiddleFingerWidthPip", "MiddleFingerWidthTip", "NeckCircumference", "NoseLength", "PalmLength", "PoplitealHeight", "RingFingerLength", "RingFingerWidthPip", "RingFingerWidthTip", "SeatHeight", "ShoulderBreadthBiacromial", "ShoulderBreadthBideltoid", "ShoulderElbowLength", "ShoulderGripLength", "ShoulderHeight", "SittingDistance", "SittingElbowHeight", "SittingEyeHeight", "SittingHeight", "SittingHipBreadth", "SittingShoulderHeight", "Span", "StandingHipBreadth", "Stature", "ThighLength", "ThighThickness", "ThumbTipToCrotch", "TopOfHeadToStomion", "TrunkLength", "UpperArmLength", "UpperLimbLength", "WorkReach", "WristWidth", "ShoulderToWristLength", "SittingUpperLegLength", "BackOfElbowToWristLength", "ElbowToMiddleFingertipLength", "CreaseBehindKneeToAnkle", "ButtockToSoleSitting", "OutsideLegLength", "MidShoulderToWaistLength", "ShoulderToFingertipHorizontal", "UpperLegLengthSitting", "WaistToCrotchLength", "FrontOfNeckToWaistLength", "ThumbLength", "VerticalGripReachStanding", "VerticalGripReachSitting", "HorizontalPinchGripReach", "EarBreadth", "HandGripHeightStanding", "NapeHeightSitting", "SacralHeightSitting", "C7HeightStanding", "C7HeightSitting", "ArmpitHeightStanding", "JawWidth", "MidShoulderHeightStanding", "MidShoulderHeightSitting", "IndexFingerHeightStanding", "WristCircumference", "HandCircumference", "FistCircumference", "WaistHeightStanding", "WaistHeightSitting", "WaistDepthStanding", "FaceBreadth", "NoseBreadth", "InterNippleDistance", "ThighCircumferenceMidpoint", "UpperArmCircumferenceMidpoint", "NeckCircumferenceAdamsApple", "HipCircumferenceMax", "MidHipCircumference", "ChestCircumferenceArmpit", "ChestCircumferenceNipple", "CalfCircumference", "KneeCircumference", "WaistCircumferenceAbdominal", "FemaleChestCircumferenceBelowBreasts", "FootHeight", "FootCircumferenceBall", "FootCircumferenceInstep", "ThighCircumferenceBelowButtock", "CircumferenceBelowKnee", "TrunkDepthAtButtocks", "ThighDepthSitting", "ShoulderDepth", "WholeBodyBreadthMax", "WholeBodyDepthMax" ], "description": "PascalCase measurement name (modeled or derived)." }, "accommodationPercent": { "type": "number", "minimum": 1, "maximum": 99 }, "gender": { "type": "string", "enum": [ "Male", "Female" ] }, "age": { "type": "number", "minimum": 0, "maximum": 120 }, "country": { "type": "string", "enum": [ "US", "UK", "CA", "FR", "DE", "NL", "SE", "DK", "NO", "CN", "JP", "KR", "IN", "ES", "IT", "AT", "BE", "CH", "PL", "TR", "MX", "AR", "BR", "AU", "NZ", "SG", "TH", "MY", "ID", "VN", "PH", "TW", "RU", "UA", "FI", "CZ", "PT", "RO", "SA", "EG", "ZA", "NG", "PK", "BD", "CO", "IE", "CL", "PE", "HK", "IL", "AE", "GR", "HU", "KE", "ET", "IR", "LK", "MA", "GH", "EC", "DZ", "VE", "MM", "IQ", "SK", "TN", "UZ", "HR", "AO", "KZ", "BG", "RS", "LT", "JO", "NP", "SI", "LV", "EE", "LB", "KH", "LU", "CY", "AZ", "LA", "BY", "MT", "IS", "BA", "AL", "MK", "ME", "MD", "TJ", "KG", "TM", "GE", "MN", "AM", "BN", "AF", "YE", "BO", "PY", "UY", "GT", "CU", "DO", "HT", "HN", "NI", "SV", "CR", "PA", "JM", "TT", "GY", "SR", "PG", "FJ", "SB", "VU", "WS", "TO", "CD", "TZ", "SD", "MZ", "MG", "CM", "CI", "NE", "BF", "ML", "MW", "SN", "TD", "SO", "ZW", "GN", "RW", "BJ", "BI", "TG", "LY", "LR", "MR", "KW", "OM", "QA", "BH" ], "default": "US" }, "unit": { "type": "string", "enum": [ "mm", "cm", "in" ], "default": "mm" }, "clothing": { "type": "string", "optional": true, "default": "nude", "description": "Clothing profile id from adjustments (e.g. nude, light, shoes, light_shoes, winter). Unknown ids return 400." }, "posture": { "type": "string", "optional": true, "default": "standing_erect", "description": "Posture profile id from adjustments (e.g. standing_erect, standing_relaxed, sitting). Unknown ids return 400." } }, "example": { "anchorMeasurement": "Stature", "anchorPercentile": 50, "linkedMeasurement": "SittingHeight", "accommodationPercent": 95, "gender": "Male", "age": 30, "country": "US", "unit": "mm" }, "response": { "anchorMeasurement": "string", "anchorPercentile": "number", "linkedMeasurement": "string", "accommodationPercent": "number", "conditionalMean": "number", "lowerBound": "number", "upperBound": "number", "unit": "mm|cm|in", "distributionPoints": "array", "remaining_free_calls": "number (when billed via free tier)" } } ], "errors": { "400": "validation_error | unknown_measurement | unknown_clothing | unknown_posture", "401": "Missing or invalid Authorization header / Invalid API key", "402": "free_tier_exhausted | insufficient_credits", "404": "model_not_found (for unknown route paths also)", "422": "gender_not_supported", "429": "rate_limited", "500": "inference_error | internal_error" } }