SteveSteve

Get shelf analysis status and result

Returns this company’s cloud capture and last successful result. Foreign or invalid IDs return 404.

GET/api/v1/shelf/sessions/{sessionId}

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

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 GET "https://api.meetsteve.io/api/v1/shelf/sessions/<string>" \
  -H "X-Request-Id: <string>" \
  -H "Authorization: Bearer <token>"

Get shelf analysis status and result

{
  "id": "string",
  "status": "created",
  "profileVersionId": "string",
  "photoCount": 0,
  "activeRunId": "string",
  "resultRunId": "string",
  "reviewStatus": "not_required",
  "error": "string",
  "result": {},
  "warnings": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z"
}

Previous

Create a shelf capture

Next

List granted shelf profiles