> ## 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. # Poll session status > Lightweight endpoint for polling session and capture completion status. ## OpenAPI ````yaml /openapi/openapi-scanner.json get /scanner/api/v1/sessions/{id}/status openapi: 3.1.0 info: title: Scanner API version: 1.0.0 description: > Barcode and product scanning with vision extraction. ## Authentication All endpoints require an API key passed via the `X-API-Key` HTTP header, unless otherwise noted. ``` X-API-Key: csb__ ``` Generate API keys in **Settings > API Keys** in your dashboard, or via the Account API. Session-based (cookie) authentication is also accepted for browser-based access. ## Rate Limits | Tier | Requests / minute | Requests / day | |-------------|-------------------|----------------| | Default | 300 | 10,000 | | Custom | Contact us | Contact us | Rate-limit headers are included on every response so callers can self-throttle without hitting our 429s ("informed governor"): - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400` - `RateLimit-Limit` — quota for the **most-restrictive** currently-active window - `RateLimit-Remaining` — requests left in that window - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew safe) Legacy `X-RateLimit-*` aliases are also emitted for back-compat. `X-RateLimit-Reset` keeps the absolute Unix-timestamp shape to avoid breaking existing consumers. When rate-limited, you receive `429 Too Many Requests` with a `retry_after_seconds` field in the error envelope and a `Retry-After` header. ## Pagination List endpoints return paginated results in this envelope: ```json { "data": [...], "pagination": { "page": 1, "page_size": 25, "total_count": 342, "total_pages": 14, "has_next": true, "has_previous": false } } ``` Use `?page=2&page_size=50` query parameters. Maximum page size is 100. ## Error Responses All errors conform to [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457) with `Content-Type: application/problem+json`: ```json { "type": "https://closient.com/docs/errors/not_found", "title": "Not Found", "status": 404, "detail": "The requested resource was not found.", "error_code": "not_found", "retryable": false, "timestamp": "2026-03-31T12:00:00+00:00" } ``` Common error codes: `unauthorized` (401), `forbidden` (403), `not_found` (404), `validation_error` (422), `rate_limited` (429), `internal_error` (500). termsOfService: https://www.closient.com/terms/ servers: - url: https://www.closient.com security: [] tags: - name: Scanner Sessions description: Create and manage barcode scanning sessions. - name: Scanner Captures description: Record barcode scan captures within sessions. - name: Scanner Enrichment description: Enrich scanned items with product data. - name: Scanner Photos description: Manage photos attached to scan sessions. - name: Scanner Upload description: Upload scan data in bulk. - name: Scanner Resolve description: >- Dual-scan QR resolve: follow QR redirect chains and save the canonical URL as a trade-item redirect (C-503). - name: Scanner Freshness description: >- Resolve color-coded freshness-chip thresholds for a scanned GTIN from the GPC-brick category config (C-2987). Anonymous-allowed; consumed by the public /scan/ overlay. externalDocs: description: Closient Documentation url: https://docs.closient.com paths: /scanner/api/v1/sessions/{id}/status: get: tags: - Scanner Sessions summary: Poll session status description: Lightweight endpoint for polling session and capture completion status. operationId: apps_scanner_api_session_endpoints_get_session_status parameters: - in: path name: id schema: description: Unique session id identifier. format: shortuuid maxLength: 22 minLength: 22 pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ title: Id type: string required: true description: Unique session id identifier. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SessionStatusResponseSchema' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: SessionStatusResponseSchema: description: Lightweight session status for polling completion. examples: - captures: - proposal_count: 3 short_id: cap-a1b2c3 status: COMPLETED extraction_status: ready session_status: COMPLETED properties: session_status: $ref: '#/components/schemas/SessionStatusEnum' description: >- Lifecycle state of the session — same set as ``SessionResponseSchema.status``. Polling clients should treat any value other than ``ACTIVE`` as terminal. extraction_status: $ref: '#/components/schemas/ExtractionStatusEnum' description: >- Vision-extraction pipeline stage. ``pending`` before submit; ``processing`` while Bedrock runs; ``ready`` once results are available for review; ``accepted`` / ``rejected`` after the operator reviews them. captures: description: Status of each capture. items: $ref: '#/components/schemas/CaptureStatusSchema' title: Captures type: array required: - session_status - extraction_status title: SessionStatusResponseSchema type: object SessionStatusEnum: description: |- Lifecycle state of a scan session. Mirrors :class:`apps.scanner.models.ScanSession.Status`. New sessions start ``ACTIVE``; a session is moved to ``COMPLETED`` by the explicit end/submit endpoints, or to ``EXPIRED`` by a maintenance job that reaps sessions which sat idle past their TTL. enum: - ACTIVE - COMPLETED - EXPIRED title: SessionStatusEnum type: string ExtractionStatusEnum: description: |- Vision-extraction pipeline stage for a scan session. Mirrors :class:`apps.scanner.models.ScanSession.ExtractionStatus`. ``pending`` is the default before submit; ``processing`` while Bedrock runs; ``ready`` once results are available for review; ``accepted``/``rejected`` after the operator reviews them. enum: - pending - processing - ready - accepted - rejected title: ExtractionStatusEnum type: string CaptureStatusSchema: description: Lightweight capture status for polling. examples: - proposal_count: 3 status: COMPLETED properties: status: $ref: '#/components/schemas/CaptureStatusEnum' description: >- Processing status of this capture. See ``CaptureStatusEnum`` for the full lifecycle. Returned alongside ``proposal_count`` so polling clients can decide between continuing to poll and transitioning to the review UI. proposal_count: default: 0 description: Number of enrichment proposals generated. title: Proposal Count type: integer required: - status title: CaptureStatusSchema type: object CaptureStatusEnum: description: |- Processing status of an individual scan capture. Mirrors :class:`apps.scanner.models.ScanCapture.Status`. Captures move ``PENDING → LOOKING_UP → ENRICHING → RESOLVING → COMPLETED``; ``FAILED`` is set on any unrecoverable error and ``NOT_FOUND`` is set when the GTIN does not match a known product after lookup. enum: - PENDING - LOOKING_UP - ENRICHING - RESOLVING - COMPLETED - FAILED - NOT_FOUND title: CaptureStatusEnum type: string securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````