Create Product Sample

Create a product sample for a specific product.
Products samples are in-situ images of customer products, used to assist mapping to existing archetypes
or train new products for recognition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 50
^[a-zA-Z0-9_\-]+$
Body Params

list of images containing the product to be recognized,

product
object

Product being sampled

string
enum
Defaults to test

Type of sample being collected

Allowed:
string

Email of the person who collected the sample

string
enum

Type of camera used to capture the sample

string
enum

Type of background used to capture the sample

Allowed:
string
enum

Type of bag used to capture the sample

Allowed:
string
enum

Size of the product in the sample

Allowed:
SmallProductQuantity | MediumProductQuantity | LargeProductQuantity

Quantity of the product in the sample

string
required
length between 1 and 50
^[a-zA-Z0-9_\-]+$

The Device that the image/s were captured on. This must match an existing device.

images
array of objects
required
length between 1 and 2

List of images containing the product to be recognized

Images*
number

Weight in grams if available. Improves results

Responses

429

Request Throttled - reduce request rate and retry

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json