SteveSteve

Create a shelf capture

Pins a profile version and creates a standalone capture. Repeating the same clientCaptureId returns the same session.

POST/api/v1/shelf/sessions

Authorization

AuthorizationRequiredBearer <token>

Steve API key, usually scoped to a company. Legacy keys and keys created by platform administrators may be unscoped; company-scoped endpoints reject unscoped keys with 403 Forbidden. Format: Authorization: Bearer aok_...

In: header

Request Body

application/jsonRequired
profileVersionIdRequiredstring
clientCaptureIdRequiredstring

Stable capture identifier, scoped to this company and caller. Retrying creation returns the same session.

Minimum length: 1Maximum length: 200
storeNameRequiredstring
Minimum length: 1Maximum length: 200
storeIdstring
webhookUrlstring
Format: "uri"

Header Parameters

X-Request-Idstring

Optional caller-supplied request identifier. Maximum length is 128 characters.

Maximum length: 128
curl -X POST "https://api.meetsteve.io/api/v1/shelf/sessions" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "profileVersionId": "string",
    "clientCaptureId": "string",
    "storeName": "string",
    "storeId": "string",
    "webhookUrl": "http://example.com"
  }'

Create a shelf capture

{
  "sessionId": "string"
}

Previous

Reserve a shelf photo upload

Next

Get shelf analysis status and result