API
πŸ“²
Deploy Experience
Learn how to use our system with Google Scene Viewer.
​Google Scene Viewer enables you to view your 3D models on any surface in your environment through a web browser or app.
Before using Google Scene Viewer make sure that your iOS device is compatible with ARKit or that your Android device has ARCore or Google Play Services for AR installed.

Adding 3D Content

Add a model hologram or image hologram through the console. You can choose any type of target. Here's how:

Launching the Scene Viewer App

Option 1: Scan a QR code

Once the 3D hologram is set you can view it instantly with Scene Viewer.
Click on the
icon to generate and show the QR codes.
Make sure the
tab or
tab is selected and shows a QR code that can be detected by the camera.
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.

Option 2: Go directly to website

Instead of scanning the QR code, you can click the
icon to automatically copy a short link to the model into your clipboard.
You can browse directly to the short link:
https://go.echo3D.co/<CODE>
Alternately, you can also browse directly to:
https://api.echo3D.co/webar?key=<YOUR_API_KEY>&entry=<ENTRY_ID>

Seeing 3D Content in AR

Click the
button.
Move the phone around until it detects the surface around you. The 3D model should appear on top of the detected surface. You might need to scale the model to make it fit the screen view.

Switching between 3D Content

You can instantly view all 3D holograms in a particular project through Scene Viewer.
Viewing multiple holograms is only available in the Team, Business, and Enterprise plans.
Go directly to:
https://api.echo3D.co/webar?key=<YOUR_API_KEY>
If your project includes more than one 3D hologram, a carousel of 3D holograms will appear at the bottom of the screen.
Switch between the holograms by clicking their thumbnail in the hologram carousel.
The carousel of 3D holograms can also appear in the AR view but only on Android devices.

Changing the Default AR Mode or Placement

Different AR modes allow for different features (such as occlusion, UI, wall placement, etc.) to take effect in the web AR viewer
If you'd like to change the default AR mode or placement used to view the 3D content, go back to the console and add metadata to change the default mode or placement. After adding metadata, relaunch the experience.
The following key are words the system uses as pre-defined metadata keys to set the default AR mode or placement:
Keyword
Type
Options
Effect
arMode
String
Either 'webxr' of 'scene-viewer'.
Default value is 'webxr'.
Sets the AR mode to the provided mode.
arPlacement
String
Either 'floor' or 'wall'.
Default value is 'floor'.
Sets the AR placement of the surface type on which the 3D model is projected.
arScale
String
Either 'auto' or 'fixed'.
Default value is 'auto'.
Set the AR scale mode which allows you to scale the model by pinching the screen (auto) or disables scaling (fixed).
shadowIntensity
String
A number between '0' to '1'. Default value is '1' for models with 'arPlacement' set as 'floor' and '0' for 'wall'.
Set the intensity of the shadow around the 3D model that appears.
shadowSoftness
String
A number between '0' to '1'. Default value is '1'.
Set the softness of the shadow around the 3D model that appears.
exposure
String
A number between '0' to '1'. Default value is '2'.
Set the intensity of the light emitted of the 3D model that appears.
minPitch
Float
A number between '0' to '180'.
Set the minimal camera pitch in the 3D preview webpage.
maxPitch
Float
A number between '0' to '180'.
Set the maximal camera pitch in the 3D preview webpage.
minYaw
Float
A number between '-180' to '180'.
Set the minimal camera yaw in the 3D preview webpage.
maxYaw
Float
A number between '-180' to '180'.
Set the maximal camera yaw in the 3D preview webpage.
Remember to relaunch the experience after adding metadata with Scene Viewer experiences for the change to take effect.

Getting 3D Content based on Location

You can choose to retrieve only 3D holograms that include a geolocation target set to a specific location around a specific radius.
Viewing holograms around a location is only available in the Team, Business, and Enterprise plans.
Go directly to:
https://api.echo3D.co/webar?key=<YOUR_API_KEY>&location=<LAT>,<LONG>&radius=<RADIUS>
Where the query parameters are:
Keyword
Description
Examples
location
A pair of GPS coordinates in the form of LAT,LONG or a location name that will be converted to GPS coordinates.
40.713054, -74.007228
New York
radius
The acceptable distance in miles between the location and the the entry's location. If radius isn't specified, a default 1 mile radius is used.
0.01

Password-Protecting Content

You can password-protect WebAR 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 are words the system uses as pre-defined metadata keys to password-protect content:
Keyword
Type
Example
passwd
String
1a2B3c4D5e6
Copy link
On this page
Adding 3D Content
Launching the Scene Viewer App
Option 1: Scan a QR code
Option 2: Go directly to website
Seeing 3D Content in AR
Switching between 3D Content
Changing the Default AR Mode or Placement
Getting 3D Content based on Location
Password-Protecting Content