Systematic Reviews

Get systematic review status and results

Poll the status of a systematic review created via POST /api/v2/sessions/systematic-reviews.

Status transitions

processing — the pipeline is running. Watch progress at url.
pausedForInsufficientQuota — the account exceeded its usage limit mid-run. The review stays paused until resumed via the links.resume URL (or the Elicit web interface) once the limit is resolved.
completed — the pipeline finished. Stage-organized exports appear under data. Only stages that actually ran are included.
failed — something went wrong. The error field contains details. data may still contain exports for stages that completed before the failure.
unknown — status is not tracked (legacy or user-created).

Response shape

data is populated as soon as each stage's outputs land — you don't need to wait for status: completed. Stages that haven't produced data yet (or that aren't part of this review's config) are simply omitted.

data.search.{csv,xlsx} — gather-stage paper list.
data.screen.{csv,xlsx} — abstract-screening results.
data.fulltext.{csv,xlsx} — fulltext-screening results (only when fulltext screening is configured).
data.extract.{csv,xlsx} — extraction-stage results.
data.report — structured content under result, plus optional pdf / docx / txt (APA reference list) / bib (BibTeX) / ris presigned download URLs.

All stage URLs are presigned for 7 days and serve with Content-Disposition: attachment so browser downloads land with the canonical filename.

dataFreshness is the ISO timestamp when the cached exports were last regenerated, or null when nothing has been generated yet.

Including the full report body

By default, data.report.result.reportBody and data.report.result.abstract are omitted to keep responses light. Append ?include=reportBody to include them.

get/sessions/systematic-reviews/{sessionId}

Path parameters

sessionIdstring uuid required

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

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

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

Query parameters

include'reportBody'

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

Response

Systematic review status and results (if completed).

type'systematicReview' 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. 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.

Current pipeline stage. Advances through gathering_sources → screening_abstract → screening_fulltext → extracting_data → generating_report → done. Null when the stage isn't known — treat it as unknown, not as not-started.

urlstring required

URL to view the review in the Elicit web interface

isPublicboolean required

Whether the review is publicly accessible via its URL without authentication

dataFreshnessstring nullable required

ISO timestamp when the exports in data were last written to S3. null when no exports have been generated yet.

Example response

{
  "sessionId": "5ad08bfb-cbe0-4911-a8c3-309760d33029",
  "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

No recorded changes to this endpoint across all 1 revision of this API.