ELelicit
Library

Retrieve a library source

Changed on

Retrieves a source by id. Includes a nullable download object with downloadUrl, expiresAt, filename, and contentType for the original stored PDF, even before parsing finishes. It is null when no stored PDF exists or a download URL is temporarily unavailable. The URL expires after 30 minutes; call this tool again for a fresh URL. Fetch download.downloadUrl with curl -L --fail --output paper.pdf '<downloadUrl>', without an Authorization header.

fullTextStatus values: pending, Elicit has not finished looking for a PDF; available, full text is ready; unavailable, no PDF was found.

Example

curl https://elicit.com/api/v2/library/sources/{sourceId} \
  -H "Authorization: Bearer elk_live_your_key_here"
get/library/sources/{sourceId}

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/library/sources/{sourceId}
  • Auth
    HTTP bearer

Path parameters

sourceIdstring uuid required

Response

The source.

idstring uuid required

Stable id of the source.

titlestring nullable required
authorsstring[] required
yearinteger nullable required
venuestring nullable required
abstractstring nullable required

Abstract as markdown.

doistring nullable required
urlstring nullable required
elicitIdstring nullable required

Elicit corpus id, present once the paper has been matched to the corpus.

pdfUrlsstring[] required
collectionIdsstring[] required

Collections this source belongs to that are visible to you.

role'writer' | 'reader' required

Your role on this source: writer for your own sources and for a shared collection's papers when you own or can edit that collection; reader for a shared collection's papers you can only view. Any role can read the source and use it in reviews. Writers edit metadata, attach a PDF, delete, and add to collections.

fullTextStatus'pending' | 'available' | 'unavailable' required

Whether parsed full text is attached: pending — a PDF is still parsing, or none has been looked for yet; available — parsed and attached; unavailable — looked for, none found.

createdAtstring required
updatedAtstring required

Changes

  • 78db836edb9cRevision changes
    • info

      added the required property to the response with the status

  • 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