Skip to main content
GET
/
scanner
/
api
/
v1
/
sessions
/
{session_id}
/
presigned-upload-url
Get presigned S3 upload URL
curl --request GET \
  --url https://www.closient.com/scanner/api/v1/sessions/{session_id}/presigned-upload-url \
  --header 'X-API-Key: <api-key>'
{
  "upload_url": "<string>",
  "upload_fields": {},
  "s3_key": "<string>",
  "expires_in": 123
}

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.

Query Parameters

​
photo_type
enum<string>
default:other

Photo classification used to namespace the generated S3 key. See PhotoTypeEnum for the full set.

Available options:
front,
back,
left,
right,
top,
bottom,
nutrition,
ingredients,
barcode,
recycling,
certification,
other
​
original_filename
string
default:photo.jpg

Original filename for extension detection.

Response

200 - application/json

OK

Presigned S3 upload URL and metadata.

​
upload_url
string
required

S3 POST URL for the upload.

​
upload_fields
Upload Fields · object
required

Form fields to include in the multipart POST.

​
s3_key
string
required

S3 object key where the file will be stored.

​
expires_in
integer
required

Seconds until the presigned URL expires.