Kivicube Docs
  • What is Kivicube
  • Getting Started
    • Create Project
      • Create Project
      • Create Scene
      • Create scene content
      • Create Scene Interaction
      • Save and Share Scene
  • Business Scene Tutorial
    • WebAR Model Video Interactive Scene Production
  • Manual
    • Editor
      • Asset Area
      • Interaction Area
        • Scene View
          • Scene Settings
      • Object Settings Panel
      • Asset Details Panel
      • Menu
        • Function Setting
        • Save and Share
    • Management Console
      • Project Management
    • Resources Specification
      • Picture
        • Basic Specification
      • 3D Model
        • Modeling Basic Specification
          • Modeling Suggestions
        • Modeling creation basic workflow
        • gltf/glb creation workflow
          • gltf/glb Model Overview
          • glTF Model Format Export Tutorial
          • Common modeling software export glTF
          • glTF Tools
          • glTF Model Format Upload Tutorial
        • USDZ creation workflow
          • USDZ Tool
          • Create AR content with Reality Composer
        • AR Model Editor
        • Model animation cut frame tutorial
        • Use Unity to do animation segmentation
        • Model normal issues
        • Non-professional modeling tool recommendation
        • Model automatic optimization tool- Microsoft Dynamics 365 Import Tool
        • Model replacement
      • Video
        • AR Video
        • Transparent video
      • Audio
        • Basic Specification
      • Background
        • Environment-360 panorama
      • Asset Converter
      • Panorama
      • Image Tracking
        • Basic Specification
        • Best Optimized Method
        • Make identification map
        • Support tracking identification map
        • 3D Tracking
  • AR Open Service
    • Image Tracking
    • Image Cloud Recognition API
Powered by GitBook
On this page
  • 1. Summary
  • 2. Platform Support
  • 3. Access Method
  • 4. Interface Document

Was this helpful?

  1. AR Open Service

Image Cloud Recognition API

PreviousImage Tracking

Last updated 4 years ago

Was this helpful?

1. Summary

Cloud Tracking, is to process the image detection and recognition capabilities through the cloud server, and obtain the processing result and feedback by the server. Actually tested 10 million image databases, in the case of a good network, the average recognition processing time is about 300ms. The number of the images is fewer, the speed is quicker.

2. Platform Support

App\small program\WebAR can be accessed

small program access reference:

3. Access Method

Please connect to buy:

4. Interface Document

Result Code

Result Code

Result Message

0

success

20001

user secret key not correct

20003

channel not exists

20004

not your channel

20005

multipart stream request needed

20006

file size limit exceeded

20007

file format not recognized

20010

image id not valid

20012

too many images

20013

image feature insufficient

20014

image identifier not exists

20015

system busy

20016

image name taken

AddImage

Request post field:

Tag

M/O

Description

username

M

user key

secretkey

M

user secret key

channel

M

channel name

identifier

M

user defined ID for each image (^[A-Za-z0-9@_.]+$ 3 to 50 digit )

metadata

O

user defined JSON string

image

M

image file (.jpg, .jpeg, .png)

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004, 20005, 20006, 20007, 20010, 20012, 20013, 20016

level

O

1 to 5 if the level is high, means the image can be detected easily

Remove Image

Request post field:

Tag

M/O

Description

username

M

user key

secretkey

M

user secret key

channel

M

channel name

identifier

M

user defined ID for each image

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004

Get Images //order by image identifier

Request post field:

Tag

M/O

Description

username

M

user key

secretkey

M

user secret key

channel

M

channel name

position

O

start index

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004

totalcount

O

total count

images

O

images

identifier

O

user defined ID for each image

metadata

O

user defined JSON string

matchratio

O

match ratio

GetImage

Request post field:

Tag

M/O

Description

channel

M

channel name

identifier

M

user defined ID for each image

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004, 20014

Statistics

Request post field:

Tag

M/O

Description

username

M

user key

secretkey

M

user secret key

startdate

M

start date (yyyy or yyyyMM or yyyyMMdd)

enddate

M

end date (yyyy or yyyyMM or yyyyMMdd)

channel

O

channel name

identifier

O

image identifier

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004, 20014

username

O

username

channel

O

channel name

records

O

records

date

O

date (yyyyMMdd)

channel

O

if channel not specified, records will show channel data

identifier

O

if channel specified, records will show identifier data

count

O

match count

FindImage

Request post field:

Tag

M/O

Description

username

M

user key

secretkey

M

user secret key

image

M

image file (.jpg, .jpeg, .png)

channel

O

channel name

Response json data:

Tag

M/O

Description

returncode

M

0, 20001, 20003, 20004, 20006, 20007, 20013

identifier

O

if image matched, will return its identifier

level

O

if channel not specified, this tag will show

URL:

URL:

URL:

URL:

URL:

URL:

https://rest.xxxx.com/AddImage
https://rest.xxxx.com/RemoveImage
https://rest.xxxx.com/GetImages
https://rest.xxxx.com/GetImage
https://rest.xxxx.com/Statistics
https://rest.xxxx.com/FindImage
https://www.yuque.com/kivicube/manual/arcloud