Skip to main content
POST
/
scanner
/
api
/
v1
/
sessions
/
{session_id}
/
photos
Register a product photo
curl --request POST \
  --url https://www.closient.com/scanner/api/v1/sessions/{session_id}/photos \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "s3_key": "<string>",
  "metadata": {},
  "photo_type": "other",
  "capture_short_id": "<string>",
  "original_filename": "",
  "file_size": 123
}
'
{
  "photo_type": "front",
  "s3_key": "<string>",
  "original_filename": "<string>",
  "sort_order": 123,
  "created": "2023-11-07T05:31:56Z",
  "metadata": {},
  "file_size": 123,
  "capture_short_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
session_id
string
required

Unique session short_id identifier.

Body

application/json

Request body for registering a product photo.

​
s3_key
string
required

S3 object key returned by the presigned upload.

​
metadata
Metadata · object

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

​
photo_type
enum<string>
default:other

Classification label — which side or aspect of the product this photo shows. Drives routing through the vision pipeline (e.g. nutrition photos go to the nutrition-facts extractor). Defaults to other when the operator does not assign a label.

Available options:
front,
back,
left,
right,
top,
bottom,
nutrition,
ingredients,
barcode,
recycling,
certification,
other
​
capture_short_id
string | null

Slug of the barcode capture to link this photo to.

​
original_filename
string
default:""

Original filename as provided by the client.

​
file_size
integer | null

File size in bytes.

Response

201 - application/json

Created

A single product photo in a scan session gallery.

​
photo_type
enum<string>
required

Classification label — which side or aspect of the product this photo shows. Drives routing through the vision pipeline (e.g. nutrition photos go to the nutrition-facts extractor).

Available options:
front,
back,
left,
right,
top,
bottom,
nutrition,
ingredients,
barcode,
recycling,
certification,
other
​
s3_key
string
required

S3 object key for the photo file.

​
original_filename
string
required

Original filename.

​
sort_order
integer
required

Display position.

​
created
string<date-time>
required

Timestamp when the photo was registered.

​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
file_size
integer | null

File size in bytes.

​
capture_short_id
string | null

Slug of the linked barcode capture.