ELelicit
Projects

Retrieve a project

Changed on

Retrieves a project by id. Available to the owner and to anyone it is shared with; role says which you are.

Example

curl https://elicit.com/api/v2/projects/{projectId} \
  -H "Authorization: Bearer elk_live_your_key_here"
get/projects/{projectId}

Request

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

Path parameters

projectIdstring uuid required

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

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

Response

The project.

idstring uuid required

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

namestring required

Project name.

goalstring required

The project's stated goal; empty string when none was set.

role'owner' | 'writer' | 'reader' required

Your access level on this project. owner: you created it, and you alone can share it. writer: you can add and remove its contents. reader: you can view it.

createdAtstring required
updatedAtstring required

Last change to the project or its contents. Lists are ordered by this, newest first.

urlstring required

URL to open this project in the Elicit web interface.

Example response

{
  "id": "9c1f6a7e-5d24-4a3b-9f0e-1b2c3d4e5f60",
  "name": "GLP-1 safety review",
  "owner": {
    "email": "owner@example.com"
  }
}

Changes

  • 27c80b9a3470Revision 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

  • 9b5b75b828abRevision 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