Find a session by BLE address
Find the active shared session of the device at a BLE address, such as the address on its NFC or QR tag. Any signed-in account may look up a session to join it. Only active sessions match; 404 when none is active. See [Devices](/docs/devices#join-a-shared-session).
/devices/sessions/by-address/{ble_address}Authorization
bearerAuth Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.
In: header
Path Parameters
The device BLE address from its tag: 12 hex digits without colons.
^[0-9A-Fa-f]{12}$Header Parameters
Send 1 to pin the documented API contract. If omitted, the latest version is selected.
"1"Value in
- "1"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/devices/sessions/by-address/string" \ -H "X-API-Version: 1"{ "success": true, "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "device_id": "string", "device_name": "string", "status": "string", "host": { "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65", "display_name": "string" }, "started_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z", "end_reason": "string", "participants": [ { "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65", "display_name": "string", "role": "host", "joined_at": "2019-08-24T14:15:22Z", "left_at": "2019-08-24T14:15:22Z" } ] }}GET /devices/sessions/{id}/summary GET
Read what a shared session you host produced: the conversations, memories, and suggestions recorded on its source between its start and its end, from your default pipeline (the one `GET /suggestions` reads). Needs `insights:read` and being the host, and not `devices:manage`. This is the one place conversations and memories are served without developer access: bounded and scoped to a meeting you hosted. `suggestions.available` is deprecated and always true. A pipeline that produced no conversations or memories gives empty lists. Each list holds at most 50 items and sets `truncated` when the session has more. Processing continues after a session ends, so read again for later results. Other participants receive 403, and accounts that never joined receive 404. See [Devices](/docs/devices#session-summary).
List endpoints GET
Next Page