Developer Guide

This article provides guidelines about formats, sizes, etc. of the reference images that you upload to your database, that will help optimize the image recognition performance. Bear in mind that the performance of the overall system depends mostly on the reference images.
Summary
Important: We recommend that reference images have any size from

A bounding box is an optional parameter that can be returned with every recognized item to indicate the position of the matched reference image inside the query image. More specifically, a bounding box represents the four corners of the matched reference image projected into the query image.

The order of the corners is: top-left, top-right, bottom

For every recognized item we return a score representing similarity between the matched object from the query image and the most similar reference image from the item.

Scores are represented with values from 0 to 100. The more similar are the matched objects the higher the score. Scores can be also seen as a measure of confidence that the matched

This section applies the following SDKs:

Augmented Reality SDK v4+
Cloud Image Recognition SDK v3.0+
On-device Image Recognition SDK v1.1+

Are you still using an older version? Previous versions of the SDKs will not receive updates anymore. If you need help transitioning to the newer version, you can get support through our support channe

Our SDKs are distributed as a .zip file that you have to manually add into your project. Depending on the SDK, you need to follow different steps:

Android Augmented Reality SDK v4 +
On-device Image Recognition SDK
Android Cloud Image Recognition SDK
Android CraftAR Pro SDK

Augmented Reality SDK v4 +

This section applies only

This article applies only to the On-Device Image Recognition SDK.

In order to add on-device collections to your Android app, it is necessary to:

create an on-device collection in CraftAR;
generate a collection bundle for your SDK version (On-device Image Recognition SDK or Augmented Reality SDK v4 +;
download the bundle of that collecti

This article applies only to the On-device Image Recognition SDK.

In order to add on-device collections to your iOS app, it is necessary to:

create an on-device collection in CraftAR;
generate a collection bundle for your SDK version (On-device Image Recognition SDK or Augmented Reality SDK v4 +;
download the bundle of that collection f

This section applies to the following Plugins:

Augmented Reality Cordova Plugin v2.4+
Cloud Image Recognition Cordova Plugin v2.4+
On-device Image Recognition Cordova Plugin v2.4+
CraftAR Pro Cordova Plugin v2.4+

Are you still using an older version? Previous versions of the SDKs will not receive updates anymore. If you need help tr

This article applies both to the On-Device Image Recognition Cordova Plugin and to the CraftAR Pro SDK Cordova Plugin.

In order to add on-device collections to your Android app, it is necessary to:

create an on-device collection in CraftAR;
generate a collection bundle for your SDK version;
download the bundle of that collection from Cr

Our SDKs are distributed as a .framework that you can directly drag into your project. It has some dependencies on frameworks/libraries that have to be linked and some compilation settings to be set.

SDK specific instructions

Choose your SDK to see how to integrate it in your project:

Cloud Image Recognition SDK
Augmented Reality SDK

This section applies to the following Plugins:

Augmented Reality Cordova Plugin v2.4+
On-device Image Recognition Cordova Plugin v2.4+
CraftAR Pro Cordova Plugin v2.4+

Are you still using an older version? Previous versions of the SDKs will not receive updates anymore. If you need help transitioning to the newer versions, you can get supp

We allow searching continuously for matches while the user just points (or tosses) the camera around – we call it Finder Mode. You can read about the Finder Mode and our Single Shot Mode in this article.

​
How can I limit the number of searches per second during Finder Mode?
You can do it through the CraftARCloudRecognition interface.

On And

In certain circumstances you may find yourself needing to use a raw cURL request to interact with our Management API. If that’s the case, you can use the examples in this article to help you out. Take into account that we strongly recommend using our native CraftAR-PHP and CraftAR-Python libraries to interact with our Management API instead of usin

This section applies the following SDKs:

Augmented Reality SDK v4+
Cloud Image Recognition SDK v3.0+
On-device Image Recognition SDK v1.1+

Are you still using an older version? Previous versions of the SDKs will not receive updates anymore. If you need help transitioning to the newer version, you can get support through our support channe

The CraftAR service provides a set of tools to build augmented reality apps. This article gives you pointers to other articles and tutorials in the Developer Guide section to help you with that.

Once you’ve developed your app, we strongly suggest you get familiar with AR Contents in CraftAR to get the best out of your app.

In order to add augment

You can render text with the CraftAR Augmented Reality SDKs for Android, iOS and the Cordova plugin for Augmented Reality by creating an image with a transparent background and your text. This can be done dynamically since the SDK allows to programmatically load any content.

Also, the CraftAR SDK allows to custiomize AR contents (see Tutorial: Cu