ELelicit
Reports

Get report status and results

Changed on

Poll the status of a report created via POST /api/v2/sessions/reports.

Status transitions

  • processing — Elicit is actively searching, screening, and extracting data. You can watch progress in real time at the url.
  • pausedForInsufficientQuota — The account exceeded its usage limit mid-run. The report stays paused until resumed via the links.resume URL (or the Elicit web interface) once the limit is resolved.
  • completed — The report is finished. The result field contains the report content.
  • failed — Something went wrong. The error field contains details.
  • unknown — Status is not tracked for this report (legacy or user-created reports).

Polling recommendation

Poll every 30–60 seconds. Reports typically complete in 5–15 minutes depending on the number of papers.

Including the full report body

By default, result.reportBody and result.abstract are omitted to keep polling responses lightweight. To include them, add ?include=reportBody to the request.

Download availability

Download URLs are optional and expire after 7 days; fetch this endpoint again for fresh URLs. exportsStatus describes the reference-list exports (txtUrl, bibUrl, risUrl), not PDF/DOCX. ready means a cached export manifest was served, which can be stale; it does not prove that missing formats have no export. generating or unavailable means no cached downloads can be served yet.

If expected reference-list URLs are missing, wait at least 60 seconds and repeat this GET, even after status: "completed" and exportsStatus: "ready". Cached manifests are reused for a 60-second cooldown, and older manifests can also be served during generation or upstream failures. One retry is not a freshness guarantee: use bounded retries with backoff, then report that the expected downloads remain unavailable instead of concluding they do not exist.

Example

# Poll for status
curl https://elicit.com/api/v2/sessions/reports/{sessionId} \
  -H "Authorization: Bearer elk_live_your_key_here"

# Fetch with full report body
curl "https://elicit.com/api/v2/sessions/reports/{sessionId}?include=reportBody" \
  -H "Authorization: Bearer elk_live_your_key_here"
get/sessions/reports/{sessionId}

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/sessions/reports/{sessionId}
  • 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

Query parameters

include'reportBody'

Set to 'reportBody' to include the full report markdown and abstract in the response

Response

Report status and results (if completed).

type'report' required
sessionIdstring uuid required

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

status'processing' | 'pausedForInsufficientQuota' | 'completed' | 'failed' | 'unknown' required

Current status of the report. Transitions: processing ⇄ pausedForInsufficientQuota (paused when the account exceeds its usage limit; stays paused until explicitly resumed via the resume endpoint or the Elicit web interface), processing → completed/failed. Poll until completed or failed.

executionStage'gathering_sources' | 'screening_abstract' | 'screening_fulltext' | 'extracting_data' | 'generating_report' | 'done' | 'null' nullable required

Current pipeline stage. Advances through gathering_sources → screening_abstract → extracting_data → generating_report → done. Null for reports created before this field was introduced or when the stage isn't known.

urlstring required

URL to view the report in the Elicit web interface

isPublicboolean required

Whether the report is publicly accessible via its URL without authentication

pdfUrlstring nullable

Pre-signed URL to download the report as PDF. Only present when status is completed and assets have been generated. Expires after 7 days — re-fetch the report for a fresh URL.

docxUrlstring nullable

Pre-signed URL to download the report as DOCX. Only present when status is completed and assets have been generated. Expires after 7 days — re-fetch the report for a fresh URL.

txtUrlstring nullable

Pre-signed URL to download the report's reference list as a plain-text (APA) file. Only present when status is completed and the report has a non-empty bibliography. Expires after 7 days — re-fetch the report for a fresh URL.

bibUrlstring nullable

Pre-signed URL to download the report's references as a BibTeX (.bib) file. Only present when status is completed and the report has a non-empty bibliography. Expires after 7 days — re-fetch the report for a fresh URL.

risUrlstring nullable

Pre-signed URL to download the report's references as an RIS (.ris) file. Only present when status is completed and the report has a non-empty bibliography. Expires after 7 days — re-fetch the report for a fresh URL.

exportsStatus'ready' | 'generating' | 'unavailable'

Availability of cached reference-list exports (txtUrl/bibUrl/risUrl); pdfUrl/docxUrl are unaffected. Only present when status is completed. ready: a cached manifest was served, which can be stale; missing URLs do not prove a format has no export. Repoll after at least 60 seconds for expected missing URLs, using bounded retries with backoff. generating: exports are being generated and no cached downloads can be served. unavailable: export generation or retrieval failed and no cached downloads can be served.

Example response

{
  "sessionId": "5ad08bfb-cbe0-4911-a8c3-309760d33029",
  "url": "https://elicit.com/review/5ad08bfb-cbe0-4911-a8c3-309760d33029",
  "result": {
    "title": "GLP-1 Receptor Agonists and Cardiovascular Outcomes: A Systematic Review",
    "summary": "This review analyzed 42 studies examining the cardiovascular effects of GLP-1 receptor agonists. The evidence suggests significant reductions in major adverse cardiovascular events (MACE), with semaglutide showing the strongest effect (HR 0.74, 95% CI 0.58-0.95)...",
    "reportBody": "# Introduction\n\nGLP-1 receptor agonists have emerged as...",
    "abstract": "This systematic review examines the cardiovascular effects of..."
  },
  "pdfUrl": "https://s3.amazonaws.com/...",
  "docxUrl": "https://s3.amazonaws.com/...",
  "txtUrl": "https://s3.amazonaws.com/...",
  "bibUrl": "https://s3.amazonaws.com/...",
  "risUrl": "https://s3.amazonaws.com/...",
  "links": {
    "self": "https://elicit.com/api/v2/sessions/reports/5ad08bfb-cbe0-4911-a8c3-309760d33029",
    "resume": "https://elicit.com/api/v2/sessions/5ad08bfb-cbe0-4911-a8c3-309760d33029/resume"
  }
}

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