If you’re reading this you probably already know what DeepAR is, and what it’s used for. In case you don’t, here’s a quick recap:
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.
After getting that out of the way, let’s get down to it.

In this post we’ll walk you through the basics of setting up a new project in DeepAR through running one of our the example app 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

Naturally, 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

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 + icon to create a new project.

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

The main variable that determines the price of every subscription plan is MAU - Monthly Active Users. This number tells us the number of unique users that use your app every month. You can change it and change your plan whenever you like.

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 though.

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 one 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 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 you'll see your App key

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

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 free filter packs for you. They contain several ready-made filters. 

You can download them here in the Downloads section.

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.

5. Starting with DeepAR Studio

DeepAR Studio is a tool for AR asset creation within DeepAR SDK. The user can create various effects that are driven by face motion and expression. It 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 SDK. In addition to fbx files, users can also load previously created effects in DeepAR Studio and edit them.

Here you can download the latest version of DeepAR Studio.

Here in the DeepAR Studio help you have all the examples and tutorials on how to use DeepAR studio.

Did this answer your question?