coverredact.com

get_status

Where things stand: engine readiness, whether the names tier is enabled, and every document on the page with its document_id, name, page count, state (queued | running | done | refused), stage (waiting | structured | names | done; edits need names or done), refusal (error code + next step), detections by category, names_checked, watermark and a short structured event log per document (its milestones plus the latest two entries; bar tallies, timings and the fuller log are on get_redaction_result). In-tab, nothing uploaded; returns geometry and counts, never any text from the document. How a document gets here: the person using the page drops or opens the PDF; tools cannot accept file bytes or URLs. If get_status lists no document and there is no person to ask - a headless run - call load_sample_document: it puts this page's own built-in sample document on the page so the tools have something to work on. It is the ONLY document a tool can introduce.

Page: /

Input schema

{
  "type": "object",
  "properties": {
    "include_events": {
      "type": "boolean",
      "description": "Include each document's event log (default true)."
    }
  },
  "additionalProperties": false
}