Projects

Shares the project read-only with an email address. Owner-only.

If the email has an Elicit account, they get read access immediately and status is registered. Otherwise a pending invitation is created and status is invited; inviting people without an account requires that your plan allows it.

An email that already has edit access keeps it: nothing is downgraded, and the response reports their role as writer. Repeating a share is safe, including for a recipient whose organization also has edit access to the project.

A 400 means the request can't produce a share: self_share for your own address, already_has_org_access when the recipient's organization already has edit access to the project so a read-only share would do nothing. A 403 means the share is not allowed: cap_exceeded when the project has reached its recipient limit, gate_denied when your plan cannot invite people without an Elicit account.

Example

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

Request

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

Path parameters

projectIdstring uuid required

The project ID (UUID) from GET /projects or POST /projects

Example:9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60

Request body

emailstring email required

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

Example request

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

Response

The share that now exists.

projectIdstring uuid required

The project ID (UUID) from GET /projects or POST /projects

urlstring required

URL to open this project in the Elicit web interface.

Example response

{
  "projectId": "9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60",
  "share": {
    "email": "colleague@example.com"
  }
}

Changes