Prepare OCR evidence
Prepare a retained OCR representation for later quote matching.
/api/v2/sources/{versionId}/representations/{representationId}/prepare-ocr-rescuehttps://api.webcite.coWhen to use it
Requires an existing, account-owned OCR source version and parser representation. An upload asset ID is not a replacement for either ID. This endpoint does not ingest a new document.
Preparation may be disabled for a deployment. A prepared artifact lets batch verification or source preview attempt a derived body reading; it does not turn an OCR match into a verified quotation. OCR provenance example.
Request
5 credits for a new successful judged preparation; retained replays do not charge again. A dispatched outcome that cannot be confirmed remains pending reconciliation.
Examples run on your server. Set WEBCITE_API_KEY first. Python examples use the requests package.
curl --fail-with-body -X POST 'https://api.webcite.co/api/v2/sources/YOUR_VERSIONID/representations/YOUR_REPRESENTATIONID/prepare-ocr-rescue' \
-H "x-api-key: $WEBCITE_API_KEY"Path and query parameters
versionId (path)stringrequiredrepresentationId (path)stringrequiredNo request body is required.
Response
Returns preparation metadata, or attempted: false with code disabled or not_ocr. The current public OpenAPI has no complete response schema for this operation.
201 response
See the response guidance above. A complete JSON schema is not published for this response.
Errors
For 400, check the request fields and source identifiers. For 401, check your API key. For 429, wait for the retry interval. See the errors guide before retrying a billable request.