Introduction
OneS1ght provides an Open API that allows you to securely connect data from your operational services without additional development and obtain innovative marketing strategies through proprietary analytics models. It supports a wide range of platforms including Web, mobile applications (iOS / Android), and POS systems.Base URL
https://api.ones1ght.com/v1/profile
API Key
| Key Type | Prefix | Purpose |
|---|---|---|
| Client SDK | osk_ | API key used in iOS, Android, and Web applications for per-user data communication. |
Common API
| Feature | Description | Endpoint | Link |
|---|---|---|---|
| API Key Validation | Check key status / expiration / type | GET /v1/validation | Docs |
Client SDK API
Profile-based conversational AI endpoints.Profile management
| Feature | Description | Endpoint |
|---|---|---|
| Create Profile | Create a profile for AI personalization | POST /v1/profile |
| Get Profile | Retrieve profile information | GET /v1/profile/{profile_id} |
| Update Profile | Update profile information | PUT /v1/profile/{profile_id} |
| Delete Profile | Delete a profile | DELETE /v1/profile/{profile_id} |
| Profile events | List SDK events accumulated on this profile | GET /v1/profile/{profile_id}/events |
Recommendation (async + polling)
| Feature | Description | Endpoint |
|---|---|---|
| Kickoff Recommendation | Fire-and-forget (~100ms immediate response) | POST /v1/chat/{profile_id}/recommend |
| List Chats | Paged history of past chats | GET /v1/chat/{profile_id}/recommend |
| Chat Detail | Polling target — returns rounds[] | GET /v1/chat/{profile_id}/recommend/{chat_id} |
| Single Round | Fetch just one round | GET /v1/chat/{profile_id}/recommend/{chat_id}/{round_id} |
| Barcode Bundle | Round products with EAN-13 PNG (base64) | GET /v1/chat/{profile_id}/recommend/{chat_id}/{round_id}/barcodes |
Triggers (event emission)
| Feature | Description | Endpoint |
|---|---|---|
| Signage ads trigger | Signage enter / exit (action: enter / exit) | POST /v1/chat/{profile_id}/trigger/signage |
| Coupon issued/used | Coupon issued / redeemed / dismissed log | POST /v1/chat/{profile_id}/trigger/coupon |
| Recommendation impression | Per-item recommended_items[] impression / tap | POST /v1/chat/{profile_id}/trigger/recommend |
Authentication
All Open API requests require anAuthorization: Bearer {API_KEY} header.
See the Authentication page for details.
Model Isolation
AI models used in the Open API are managed separately from tenant chat models. Models created with theOpen API type in the admin panel are only accessible from external apps.