Sessions

Share a session

Share a session read-only with another person by email. Works for every session type — reports, systematic reviews, and Research Agent sessions. Sessions are shared read-only: the recipient can view the session but cannot modify, resume, stop, or re-share it (agent sessions are read-only by design; report and systematic-review shares are read-only through the API).

If the email belongs to an existing Elicit account the share takes effect immediately (status: "registered"). Otherwise a pending invitation is created and an email is sent (status: "invited"); the share activates when they create an account.

Only the session owner can manage shares. A recipient of a shared agent session sees it in GET /api/v2/sessions with role: "shared"; a recipient of a shared report or systematic review opens it via the returned web-app url — it will not appear in their GET /api/v2/sessions list, which stays owner-only for review sessions.

Example

curl -X POST https://elicit.com/api/v2/sessions/{sessionId}/shares \
  -H "Authorization: Bearer elk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"email":"colleague@example.com"}'

post/sessions/{sessionId}/shares

Path parameters

sessionIdstring uuid required

The session ID (UUID) returned by the create endpoints and GET /sessions

Example:5ad08bfb-cbe0-4911-a8c3-309760d33029

The session ID (UUID) returned by the create endpoints and GET /sessions

Request body

emailstring email required

Email address to share the session with, as a read-only recipient.

Example request

{
  "email": "colleague@example.com"
}

Response

The session was shared with the recipient.

sessionIdstring required

Unique identifier for the session.

urlstring required

URL to view and continue the session in the Elicit web interface.

Example response

{
  "share": {
    "email": "colleague@example.com"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.