Search checks
Full-text search over the account's checks: the title, the whole document and the names of the sources it matched. Every word is required and matches as a prefix, so segur finds seguramente; accents are ignored. Checks whose title holds every word come first, then the best text matches, then the newest. excerpt is a window of the document around the hit with each matched run wrapped in [[ and ]].
Authorization
bearerAuth Create a key under Account → API. Send it as Authorization: Bearer st_live_…. Keys carry scopes: checks:write (create, cancel, delete; add, change and delete source rules), checks:read (list, get; list source rules) and usage:read (credit position).
In: header
Query Parameters
The words to find.
length <= 200Hits to return, 1 to 200 (default 50). total counts every match.
1 <= value <= 200Response Body
application/json
curl -X GET "https://example.com/v1/checks/search?q=climate"{ "hits": [ { "id": "string", "matchedIn": [ "title" ], "excerpt": "string", "excerptAtStart": true } ], "total": 0}Create a check from text or a file POST
One call runs the plagiarism, grammar, citation, AI-content and style checks on a document. Every refusal about the document itself answers here, synchronously (`no_input`, `no_checks_selected`, `too_short`, `too_long`, `unsupported_type`, `unreadable_file`, `file_too_large` (413), `unsupported_language`, `multiple_inputs`, `invalid_file`), so a check that is accepted (202) has been read and will run. Only a scanned PDF or an image is read later, by OCR, while the check runs.
Get a check GET
The status, progress and phase while the check runs; the report once it is done. `?view=summary` returns the scalar fields and scores only (cheap polling); `?include=` names the report parts to return (text, spans, matches, sources, issues, scores, meta) and wins over `view`. The default is the full report.