Object Detection in Existing Visual Search Session

Deprecated

GET

/search/session/{search-id}/detect-objects

const url = 'https://api.vviinn.com/search/session/602d20ad1ac7d8-15165248/detect-objects';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vviinn.com/search/session/602d20ad1ac7d8-15165248/detect-objects \
  --header 'Authorization: Bearer <token>'

Get detected objects of image in existing session.

Authorizations

read-only-token
site-credentials

Parameters

Path Parameters

search-id

required

string

Example

602d20ad1ac7d8-15165248

Query Parameters

campaign-id

One of:

integer
string

integer

Example

string

Example

2d45fd08-9ba4-4f57-81d9-fe75069f64dd

Responses

200

Detected objects response

application/json

object

value

Array<object>

object

value

object

classId

integer

class

string

score

required

integer

rectangle

required

object

left

number

top

number

width

number

height

number

links

Example

{
  "value": [
    {
      "value": {
        "rectangle": {
          "left": 0,
          "top": 0.3641,
          "width": 0.94,
          "height": 0.54175
        }
      }
    }
  ]
}

400

ProductSearch exception

application/json

Example

{
  "message": "Could not detect objects",
  "data": ""
}

401

Authentication Error

application/json

Example

{
  "message": "Authentication Error"
}

403

Authorization Error

application/json

Example

{
  "message": "Authorization Error"
}