Wikitude Cloud Recognition

The Wikitude Cloud Recognition service is cloud-based service provided by Wikitude, which recognizes images sent from Android and iOS apps using the Wikitude SDK. The recognized images are then tracked in the live camera feed and can be used for augmented reality experiences.

This documentation focuses on the RESTful API called Manager API, which is used to interact on a back-end level with the Cloud Recognition service.

General Definitions

Manager API: A RESTful web API allowing developers to interact with the Cloud Recognition server for managing Targets, TargetCollections and Cloud Archives. Only you as a developer uses this API. None of your users of your app will interact with this API.

Client API: The Client API is the interface between the Wikitude SDK and the Cloud Recognition Service. The API itself is encapsulated in the Wikitude SDK class AR.CloudTracker and not directly accessible. Calls on the client API are called Scans.

Getting Started with the Cloud Recognition Service

Preparation

  1. Create a free Wikitude developer account or log-in if you are a returning developer
  2. Get the API tokens for the Manager API and the Client API to start your project. Read more on authentication
  3. Test the API for free using Wikitude's sample integrations
  4. Once you finished your integration, purchase a commercial token.

First Steps and General Usage

  1. Get familiar with the Manager API calls in the API Reference
  2. Create a first Target Collection using the Create Target Collection endpoint and note down the ID of the Target Collection
  3. Create targets using the Create Target endpoint for that particular Target Collection
  4. Important: Generate a Cloud Archive for your Target Collection
  5. Go to the Wikitude SDK and create an Android or iOS project
  6. Use the Client API token to authenticate your Android or iOS project
  7. Use your Target Collection ID to recognize images

For more information on the available endpoints and how to work with the Manager API see the workflow section.

Authentication

The Cloud Recognition Service knows two authentication tokens, that you need in order to work with the service

Authentication on the Manager API

The Manager API token must be added to each call towards the Wikitude Cloud Recognition Manager API. The token authenticates the user account that is using the API.

Authentication on the Client API

The Client API token must be added to your app project using the Wikitude SDK. This token is needed additionally beside the SDK license key when working with the AR.CloudTracker class.

Quota and Limits

General Upload Limit

The Wikitude Cloud Recognition will not accept images bigger than 1024kB (1 MB). Trying to upload images exceeding this file size will result in a HTTP status code 400 together with an error message FILE_SIZE_LIMIT_EXCEED.

Limits for the Wikitude Cloud Recognition Service

There are two main limitations for the Wikitude Cloud Recognition service that you need to be aware of:

Maximum Number of Targets in a Target Collection

A target collection can't exceed 50,000 targets.

Free Trial License for Cloud Recognition

Wikitude provides a trial token for each developer account to try out the Cloud Recognition for free. This trial token has set a quota limit that allows developers to try and test the functionality of the service. Limitations for trial accounts

To get your trial token, please visit the License page.

Commercial Licenses

For production systems, we offer commercial licenses with various quota limits for purchase.

Product Targets Scans
Cloud Recognition 1000 1,000 1,000,000
Cloud Recognition 10000 10,000 1,000,000
Cloud Recognition 25000 25,000 1,000,000
Cloud Recognition 50000 50,000 1,000,000
Cloud Recognition 100000 (*) 100,000 1,000,000

(*) Maximum number of targets per target collection can't exceed 50,000