Sign in
Sessions

Resume a paused session

Resume a report, systematic review, or research-agent session that was automatically paused because your account was over its usage limit (status: "pausedForInsufficientQuota" from the get endpoints).

Pass the sessionId from the create response or GET /api/v2/sessions — the session type is resolved automatically. Paused sessions also carry a ready-made links.resume URL for this endpoint.

A paused session stays paused until it is explicitly resumed. Once the usage limit is resolved (for example after upgrading or when a new billing period starts), call this endpoint — or use the resume banner in the Elicit web interface — to continue the run.

Example

curl -X POST https://elicit.com/api/v2/sessions/{sessionId}/resume \
  -H "Authorization: Bearer elk_live_your_key_here"
post/sessions/{sessionId}/resume

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

Response

Session resumed. status reflects the row after the resume; poll links.self for progress.

type'report' | 'systematicReview' | 'agent' required

Which kind of session was resumed

sessionIdstring uuid required

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

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

Status after the resume — normally processing; completed or failed if the run finished while the resume was in flight.

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

The stage the session resumed at

urlstring required

URL to view this session in the Elicit web interface

isPublicboolean required

Example response

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