Get image predictions

Return image predictions based on various filters. The results can be filtered by model name, type, confidence, and more.

Query Parameters

count?integer

The number of items to return

Default25

Range1 <= value

page?integer

Page index to return (starting at 1)

Default1

Range1 <= value

server_type?string

The server type (=project) to use, such as 'off' (Open Food Facts), 'obf' (Open Beauty Facts),...

Default"off"

Value in"off" | "obf" | "opff" | "opf" | "off_pro"

barcode?string

Filter by barcode value

with_logo?boolean | null

if True, only return image predictions that have associated logos (only valid for universal-logo-detector image predictions). If false, only return image predictions that have no associated logos. Otherwise, return all image predictions.

Defaultnull

model_name?string

filter by name of the image predictor model

image_id?string

filter by image ID. It should be a digit (raw images only), otherwise no result will be returned.

type?string

filter by type of the image predictor model

model_version?string

filter by model version value

min_confidence?number

filter by minimum confidence score value

Range0 <= value <= 1

Response Body

curl -X GET "https://robotoff.openfoodfacts.org/api/v1/image_predictions?count=25&page=1&server_type=off&barcode=5410041040807&model_name=universal-logo-detector&image_id=1&type=object_detection&model_version=string&min_confidence=1"

{
  "status": "no_image_predictions",
  "image_predictions": [
    {}
  ],
  "count": 0
}

Get image predictions

Query Parameters

Response Body

200