Sessions

Grant read-only access to a session by email. Works for every session type — reports, systematic reviews, and Research Agent sessions. New recipients can view the session; this grant does not let them modify, resume, stop, or re-share it.

Existing editor or reviewer permissions on reports and systematic reviews are preserved, not downgraded. The returned share.role: "reader" describes this API's read-only grant, not the recipient's full effective permissions. Inspect or change higher-permission roles in the web interface; they are not returned by the list-shares endpoint. Revoking the email with DELETE still removes its direct share, including an existing editor or reviewer grant.

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

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/sessions/{sessionId}/shares
  • Auth
    HTTP bearer

Path parameters

sessionIdstring uuid required

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

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

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 the session in the Elicit web interface. Available actions depend on your permissions.

Example response

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

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status