SteveSteve

Cancel shelf analysis

Cancels an open or active capture. A terminal outcome is unchanged. Late worker results cannot overwrite cancellation.

POST/api/v1/shelf/sessions/{sessionId}/cancel

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
bodyRequiredobject

Path Parameters

sessionIdRequiredstring

Steve session identifier.

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/<string>/cancel" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Cancel shelf analysis

{
  "status": "string"
}

Previous

Register an uploaded shelf photo

Next

Reserve a shelf photo upload