Last 7 days, UTC

Average Latency
97ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Header Authentication
 

You can get your secret token from https://platform.kooaba.com/datakeys


Authentication
Description
Parameter
String

Should be of the format 'Token [secret-token]'

Authorization

Required

Endpoints

HTTP 200 : Add additional images to an item Response Model POST/items/{itemUUID}/images
						[
  {
    "sha1": "<sha1>"
  },
  {
    "sha1": "<sha1>"
  }
]						
Add additional images to an item

Test console
Description
Parameter
string

itemUUID

Required

binary

set of image files (1 or more, each as a separate part ‘images’ in multipart)

images

Required

HTTP 200 : Create an item Response Model POST/buckets/{bucketUUID}/items
						{
   "uuid" : "<item_uuid>",
   "enabled" : <isEnabled>,
   "images" : [ {"sha1":"<sha1>" }, {"sha1":"<sha1>"} ]
 }						
Create an item

Test console
Description
Parameter
string

bucketUUID

Required

string

String. An item title you can set. Will be returned at recognition.

title

Optional

string

String. A reference id. This is typically used to carry your internal id’s such as product id, etc. Will be returned at recognition ad allows for identifying the item that was matched

reference_id

Optional

boolean

true/false, defaults to true. If the item is enabled for recognition or not.

enabled

Optional

binary

set of image files (0,1 or more, each as a separate part ‘image’ in multipart/form-data)

images

Optional

string

JSON formatted string. In addition to title and reference_id, this field allows you to store any kind of information you may want to return to the client upon recognition.

metadata

Optional

HTTP 200 : Add additional images to an item Response Model DELETE/items/{itemUUID}
						[
  {
    "sha1": "<sha1>"
  },
  {
    "sha1": "<sha1>"
  }
]						
Delete an item

Test console
Description
Parameter
string

itemUUID

Required

HTTP 200 : Get an item Response Model GET/items/{itemUUID}
						{
   "uuid" : "<item_uuid>",
   "reference_id" : "<reference_id>",
   "title" : "<title>",
   "enabled" : "<true/false>"
   "metadata" : {...} // a json object
   "images" : [ {"sha1":"<sha1>" }, {"sha1":"<sha1>"} ]
 }						
Get an item

Test console
Description
Parameter
string

itemUUID

Required

boolean

metadata

Optional

boolean

images

Optional

HTTP 200 : Get the status of an item Response Model GET/items/{itemUUID}/status
						{
   "uuid" : "<item_uuid>",
   "status" : "<activating/ready/error/mixed>"
   "images" :
     [
        {
          "sha1":"<sha1>" ,
          "status" : "<activating/ready/error>"
        },
        {
          "sha1":"<sha1>",
          "status" : "<activating/ready/error>"
        }
     ]
 }						
Get the status of an item

Test console
Description
Parameter
string

itemUUID

Required

HTTP 200 : Index Response Model GET/buckets
						[
   {
     "uuid" : "<bucket_uuid>",
     "name" : "<name>",
     "service_id" : "<service>"
   }, ...

 ]						
Index

Returns a list of buckets the API user has access to.


HTTP 200 : List items Response Model GET/buckets/{bucketUUID}/items
						[
   {
     "uuid" : "<item_uuid>",
     "title" : "<item_title>",
     "reference_id" : "<reference_id>",
     "enabled" : "<isEnabled (true/false)>"
   }, ...

 ]						
List items

List the items in a bucket. Up to 100 items are returned for each page.


Test console
Description
Parameter
string

bucketUUID

Required

string

Number. The page number for the items to list. The first page is page 0. (e.g. /api/v4/buckets/:bucketUUID/items?page=0)

page

Optional

HTTP 200 : Add additional images to an item Response Model PUT/items/{itemUUID}
						[
  {
    "sha1": "<sha1>"
  },
  {
    "sha1": "<sha1>"
  }
]						
Update an item

Test console
Description
Parameter
string

itemUUID

Required

string

will replace (or set, if it was unset) the item title

title

Optional

string

will replace (or set, if it was unset) the reference_id

reference_id

Optional

boolean

change the enabled flag

enabled

Optional

string

replaces metadata with new data sent with the update request

metadata

Optional

Consume this API completely for free!


By joining the mashape API marketplace you can start using Kooaba Image Recognition Upload API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.