Skip to main content

Webflow API References

Initialization Method​

To get started, call the GlamAR.init method. This adds the GlamAR SDK into the target container and configures it with the provided API key and optional configuration.

GlamAR.init(containerId, apiKey, options);

Initialization Payload

NameTypeDescription
platformstringPlatform you're targeting (e.g. web)
categorystringSupports lots of categories
metaMetaOptionsOptional initialization metadata object
configurationConfigurationOptionsInitialization configuration object

MetaOptions

NameTypeDescription
preloadMLModelsstring[]Downloads the listed ML models during SDK initialization. AR Try-On supports face, hair, hand, and light. Skin Analysis supports face and light.

Following are all the configuration options that can passed under thepayload object.
Subcategories defined in overview section can be passed in the category parameter.

ConfigurationOptions

NameTypeDescription
skinAnalysisSkinAnalysisOptionsOptions regarding skin anaylysis

SkinAnalysisOptions

NameTypeDescription
appIdstringSkin analysis application ID

Basic Example

GlamAR.init("containerId", "accessKey", {
"platform": "web",
"category": "skinanalysis",
"meta": {
"preloadMLModels": [
"face",
"light"
]
},
"configuration": {
"skinAnalysis": {
"appId": "your_app_id"
}
}
});

Post-Initialization Methods​

addEventListener​

GlamAR.addEventListener(eventName, handlerFunction);

Adds the listener to the given event name.
Return Value: None

ParametersTypeDescription
eventNamestring

A Name of specific event or "*" To listen to the all the events.

handlerFunctionfunction Your handler function that will listen to callback.

removeEventListener​

GlamAR.removeEventListener(eventName, handlerFunction);

Removes the given listener for the event name.
Return Value: None

ParametersTypeDescription
eventNamestring

A Name of specific event or "*" To remove all the events.

handlerFunctionfunction Your handler function that will listen to callback.

isLoaded​

GlamAR.isLoaded();

Returns the status of module loading.
Return Value: true if loaded, otherwise false

ParametersDescription

None

No parameters required.

skinAnalysis​

GlamAR.skinAnalysis("start");

Opens the Skin Analysis flow.
Return Value: None

ParametersDescriptionTypeOptions
optionsPass start (Required)stringstart

reset​

GlamAR.reset();

Removes all the current effects from the canvas.
Return Value: None

ParametersDescription

None

No parameters required.

close​

GlamAR.close();

Closes canvas and returns to the main widget page.
Return Value: None

ParametersDescription

None

No parameters required.

snapshot​

GlamAR.snapshot();

After a successfully scan, client can be get a PDF of his scan from share event
Return Value: none

ParametersDescription

None

No parameters required.

back​

GlamAR.back();

To simulate back button without using UI
Return Value: None

ParametersDescription
None No parameters required.

Events​

Check Events Page for event details.