Comment on page

Deploy Experience

Learn how to use our system with FaceAR.
FaceAR is a web-based library that enables you to view your 3D content through a web browser and supports face tracking.

Adding 3D Content

Add any type of asset through the console. You can choose any type of target. Here's how:

Launching the FaceAR App

Option 1: Scan a QR code

Once the 3D asset is set you can view it instantly with FaceAR.
Click on the
icon to generate and show the QR codes. Choose the "See on a face" tab.
Scan the QR code with your phone's camera app or with a QR reader app.
Latest iOS and Android phones are able to read QR code with their default camera apps.
Click the pop-up message to get redirected to our website. Your browser should open.
You might need to allow camera access. In iOS, we recommend using the Safari browser. In Android, Chrome browser is recommended as the default browser.
Your camera should open in the browser.

Option 2: Go directly to website

Instead of scanning the QR code, you can also browse directly to:<YOUR_API_KEY>
Your camera should open in the browser.

Seeing 3D Content in AR

Now that the camera is running in your browser, keep the camera pointed to a face to see the 3D model appear.

Capturing the AR Moment

You can snap a picture of the AR scene by clicking the
button on the bottom of the screen.
An image will be captured and saved to your device.
Share it with others! 💗

Password-Protecting Content

You can password-protect FaceAR experiences so that users that access the experience will be prompted to enter a password.
If you'd like to password-protect the 3D content, go back to the console and add metadata to set a password. After adding metadata, relaunch the experience.
The following key is a word the system uses as pre-defined metadata keys to password-protect content: