Citecheck

Cancel a citation check

Stop a citation check. Returns the check as it stands afterwards, status: cancelled.

You are charged only for the citations it checked before the cancel; the rest are refunded. A check that had already finished is returned unchanged (completed or failed); cancelling again is safe.

Versions. 200: 2026-10-11 receives CitecheckOut, 2026-05-13 receives CitecheckOutLegacy; 403: 2026-10-11 receives CitecheckErrorOut, 2026-05-13 receives CitecheckErrorOutLegacy; 404: 2026-10-11 receives CitecheckErrorOut, 2026-05-13 receives CitecheckErrorOutLegacy; 410: 2026-10-11 receives CitecheckErrorOut, 2026-05-13 receives CitecheckErrorOutLegacy; default: 2026-10-11 receives ErrorOut, 2026-05-13 receives ErrorOutLegacy.

post/api/v1/citechecks/{citecheck_id}/cancel

Request

  • Base URL: https://lenz.io
  • URL: https://lenz.io/api/v1/citechecks/{citecheck_id}/cancel
  • Auth: HTTP bearer

Path parameters

citecheck_idstring required

Headers

X-Lenz-API-Versionstring
Example:2026-05-13

The API version to answer in, as a date. A date before 2026-10-11 (or a value that is not a date) gets 2026-05-13. See https://lenz.io/docs/api-versions.

Response

OK

citecheck_idstring required
status'queued' | 'checking' | 'completed' | 'failed' | 'cancelled' required

cancelled: you cancelled it (POST /citechecks/{citecheck_id}/cancel). Only citations it checked before that are charged.

outcome'clean' | 'issues_found' | 'incomplete' | 'unchecked' nullable required

Null until terminal. incomplete: a citation could not be checked for a reason of ours.

created_atstring required
completed_atstring nullable required
languagestring required

The language the reasoning is written in, as the review envelope echoes it.

poll_after_secondsinteger nullable required

Changes

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