GET /devices/sessions/{id}/summary
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).
/devices/sessions/{id}/summaryAuthorization
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
uuidHeader 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/497f6eca-6276-4993-bfeb-53cbbbba6f08/summary" \ -H "X-API-Version: 1"{ "success": true, "data": { "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82", "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81", "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0", "conversations": { "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "summary": "string", "maturity": "string", "started_at": "2019-08-24T14:15:22Z", "ended_at": "2019-08-24T14:15:22Z" } ], "truncated": true }, "memories": { "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "title": "string", "content": "string", "timespan": { "from": "2019-08-24T14:15:22Z", "to": "2019-08-24T14:15:22Z", "incomplete": true } } ], "truncated": true }, "suggestions": { "items": [ { "action": "string", "why_now": "string", "basis": "stated_intent", "roles": [], "due": { "wording": "string", "at": "2019-08-24T14:15:22Z", "timezone": "string", "uncertain": true }, "not_before": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "expiry_explanation": "string", "presentation": null, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0", "revision": 1, "state": "suggested", "state_version": 1, "protected_fields": [ "/action" ], "grouping": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "version": 1, "label": "string", "member_ids": [ "6059d331-91d8-43de-a6af-f1a743933a5b", "6059d331-91d8-43de-a6af-f1a743933a5b" ] }, "canonical_id": "427e30c8-bfd7-48b3-b48e-acffdd2452c2", "needs_review": true, "review_reason": "string", "snoozed_until": "2019-08-24T14:15:22Z", "first_surfaced_at": "2019-08-24T14:15:22Z", "last_surfaced_at": "2019-08-24T14:15:22Z", "evidence_started_at": "2019-08-24T14:15:22Z", "evidence_ended_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "truncated": true, "available": true } }}Leave a session POST
Leave a shared session. Leaving never ends the session, and leaving again is safe. The host ends the session instead and receives 409 CONFLICT.
Find a session by BLE address GET
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).