> ## 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. # Create a scan session > Create a new scan session for barcode and QR code scanning. ## OpenAPI ````yaml /openapi/openapi-scanner.json post /scanner/api/v1/sessions 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: post: tags: - Scanner Sessions summary: Create a scan session description: Create a new scan session for barcode and QR code scanning. operationId: apps_scanner_api_session_endpoints_create_session parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/SessionCreateSchema' required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SessionResponseSchema' security: - APIKeyHeaderAuth: [] - OAuthTokenAuth: [] - SessionAuth: [] components: schemas: SessionCreateSchema: description: Request body for creating a new scan session. examples: - capture_mode: barcode_scan device_context: app_version: 2.1.0 platform: ios metadata: order_id: '6735' organization_short_id: keATfB8VP2gSjcnTbsMNQL user_agent: Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) properties: metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' description: >- Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved. title: Metadata organization_short_id: default: '' description: >- Organization short_id. Required for session auth; optional for API key auth (inferred from key). title: Organization Short Id type: string user_agent: default: '' description: Browser user-agent string of the scanning device. title: User Agent type: string device_context: anyOf: - additionalProperties: true type: object - type: 'null' description: Device metadata. title: Device Context capture_mode: allOf: - $ref: '#/components/schemas/CaptureModeEnum' default: barcode_scan description: Capture mode for this session. title: SessionCreateSchema type: object SessionResponseSchema: description: Scan session summary. examples: - capture_count: 5 capture_mode: barcode_scan created: '2025-08-15T14:00:00Z' metadata: order_id: '6735' modified: '2025-08-15T14:30:00Z' photo_count: 3 status: active properties: metadata: additionalProperties: type: string description: >- Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars. title: Metadata type: object status: $ref: '#/components/schemas/SessionStatusEnum' description: >- Lifecycle state of the session. ``ACTIVE`` while the operator is still adding captures; ``COMPLETED`` once they explicitly end or submit it; ``EXPIRED`` if a maintenance job reaped the session after sitting idle past its TTL. capture_mode: $ref: '#/components/schemas/CaptureModeEnum' description: Session capture mode. created: description: Timestamp when the session was created. format: date-time title: Created type: string modified: description: Timestamp when the session was last modified. format: date-time title: Modified type: string capture_count: default: 0 description: Total number of captures. title: Capture Count type: integer photo_count: default: 0 description: Total number of product photos. title: Photo Count type: integer required: - status - capture_mode - created - modified title: SessionResponseSchema type: object CaptureModeEnum: enum: - barcode_scan - product_photography - both title: CaptureModeEnum type: string 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 securitySchemes: APIKeyHeaderAuth: type: apiKey in: header name: X-API-Key OAuthTokenAuth: type: http scheme: bearer SessionAuth: type: apiKey in: cookie name: sessionid ````