Overview — IngevoraMirage

OverviewIngevoraMirage lets your team make face lenses and screen effects for your app in a browser, publish them, and fetch them from your app with an API key.Two products

Product

What it is

What it reacts to

Face lenses

Layers drawn on a face that the camera tracks: stickers, masks, frames, colour looks, animated sprites and particles.

The face — an open mouth, a smile, a blink, raised brows, a head tilt — and events your app sends.

Screen effects

Short overlays that play above your app's own screens: particles, images, sprites, a shake, a flash or a pulse. They use no camera.

Their own start and end, and events your app sends.

Each product is switched on or off for each workspace. The Developers page in the editor shows which are on for yours.How it works

Make it in the editor. The editor is a studio in your browser at https://ingevoramirage.ingevora.com. Start from a template or a blank item, add layers, and watch the live preview as you work. Every change saves itself.

Try it. You can try a face lens on your own phone with Test on phone before anyone else sees it. A screen effect plays in the studio's phone-screen viewer.

Publish. Publish checks the item and freezes it as a numbered version: version 1, then 2, and so on. A published version never changes. Edits you make afterwards change only the draft, until you publish again.

Get an API key. An Owner or a Developer of your workspace issues a key on the API keys page. The key is shown once.

Fetch it. Your server asks the delivery API at https://mirage-api.ingevora.com for the latest version, or for a version you pin. The answer says where the version's files are. You download them and check each file's SHA-256 before you use it.

Draw it. Your app draws the lens on the camera picture, or plays the effect above its screens.

Note: Native SDKs for iOS and Android are coming soon. They are not available yet. Until they ship, apps use the delivery API directly and draw the downloaded package themselves. See iOS SDK and Android SDK.

Who does whatYour team works in a workspace, and each person has one role:

Owners manage the team, the workspace's name and its API keys, and can do everything a Designer does.

Designers make, edit, test and publish face lenses and screen effects.

Developers view face lenses and screen effects, manage API keys, and connect your app to the delivery API.

See Workspaces and roles.What a published version containsA published version is a small package: one manifest.json file that describes the layers, where they sit and what triggers them, plus the PNG images those layers use. Images you uploaded but never used stay out of it.A package holds no code. Triggers are rules written as data — when this event happens, do these actions — so your app only ever downloads data and images.Limits that keep packages lightEvery item has fixed limits: up to 8 layers, images no larger than 1024 pixels on a side, and a size cap on all its images together (2 MiB for a face lens, 3 MiB for a screen effect). Your workspace may also have rules, such as keep-out zones over the mouth and eyes. See Rules and keep-out zones.Where to go next

New here: Getting started goes from your first sign-in to your app's first request.

Designers: Studio tour, Face lenses, Screen effects, Triggers and your events, Keyframe animation and Sprite sheets.

Developers: API keys, Delivery API, Downloading safely and Errors and limits.

Everyone: Test on your phone and Versions, latest and pinned.