Skip to main content

How It Works

DeepAR Universal SDK

DeepAR is an Augmented Reality platform made for developers who want to add the highest quality, mobile optimised, Snapchat and Facebook-style 3D and realistic face lenses, masks and special FX to iOS, Android, and Web apps.

In this post we’ll walk you through the basics of setting up a new project in DeepAR. We'll run one of our the example apps we prepared for new users:

  1. Signing up

  2. Creating a project

  3. Running the example project

  4. Downloading the free filter pack

  5. Starting with DeepAR Studio

1. Signing up

The first step is to sign up and create your DeepAR account. If you haven't done that by now, you can do it here: DeepAR Sign Up.

2. Creating a project

After you’ve signed up and logged in to the DeepAR, you can create your new project. Go to the Projects and click the + New Project button to create a new project.

Adding New Project

A slider with all available subscription plans will appear. Depending on your needs, you can move the slider and choose a plan that suits you best.

The main variable that determines the price of every subscription plan is MAU - Monthly Active Users. This number represents the number of unique users that use your app every month. You can change MAU and your plan at any point.

Also, here you can choose if you want to have your subscription charged monthly or annually. The in-app watermark is removed only in paid plans.

Next, choose the project name, review and check the terms and conditions and create the project.

3. Running the example project

We have several examples that you can try out on GitHub.

To access them, click on the Examples button in the DeepAR Developer Portal. DeepAR that will lead you to DeepAR SDK on Github.

Here is a DeepAR SDK example project for iOS :


To run the example:

  • Clone or download the quickstart-ios-objc project from Github

  • Open that project in Xcode

  • Next, you need to generate a license key for your app to connect with SDK

  • Go to your DeepAR Project and click Add iOS App

  • Choose a name for your App

  • For Bundle ID copy the Bundle Identifier from Xcode and paste that to Bundle ID

  • Click the Create App button and then your App key under Copy SDK Key or by clicking the key icon.

Project Details

  • Copy the App Key and paste it in Xcode to ViewController.m (instead of your_license_key_goes_here string)

License Key

Next, download the iOS SDK from DeepAR Downloads and copy the DeepAR.framework into quickstart-ios-objc folder.

That's it, now you can run your project.

4. Downloading the free filter pack

To help you understand the process of creating and adding filters mask we prepared a Free Studio Filters Pack for you. It contains several ready-made filters.

Download the free filter pack here.

You can see all the free filters here. All filters can be downloaded and used as examples, or you can use them to create your own filters.

Filter Photo

5. Starting with DeepAR Studio

DeepAR Studio is a tool for AR asset creation within DeepAR SDK. You can create various effects that are driven by face motion and expression. The Studio imports .fbx models created by other 3D modeling tools (like Maya and Blender) and exports the effects in the format that can be used by DeepAR SDK on iOS, Android or Web. In addition to .fbx files, you can also load previously created effects in DeepAR Studio and edit them.

DeepAR Studio Gif

Here you can download the latest version of DeepAR Studio.

See DeepAR Studio documentation for more information and tutorials.