Scanning
copyleaks_scan - Run a Copyleaks scan
Write · spends credits
Runs a scan and returns a handle to check on. Accepts pasted text, a web address, files, or an uploaded image.
You don’t choose the detectors per scan - the scan profile does. Which detectors run comes from the profile named in
scan.profile, or your account default when you omit it. Read a profile with copyleaks_get_profiles to see what it will run, or change it with copyleaks_update_profile.
detections in the results lists what actually ran - AI Detection skips text under 350 characters.
Returns immediately with a scan that is still running. Follow with copyleaks_scan_status, then copyleaks_get_results.
copyleaks_rescan - Re-run an existing scan
Write · spends credits
Runs an existing scan again against current sources, so a document can be re-checked as the web changes. Creates a new scan; the original and its results are unchanged.
copyleaks_request_upload - Get a place to send a file
Write · costs no credits
Returns an address to send one file to, and a handle that names that file in a later scan. Use it for anything past a small file, rather than sending bytes inside copyleaks_scan.
Send the file to the address, then start the scan with the handle. The address works once and also expires after a set time; the handle starts one scan. If either has been spent, ask for another. A failed upload does not spend the address.
Reading results
copyleaks_scan_status - Check scan status
Read-only
Returns whether a scan is running, complete, or failed. While running, may include how far along it is as a percentage.
No time estimate, and no notification when a scan finishes - check here, and wait between checks. Prefer
waitSeconds: one call holds until the scan finishes or the wait runs out, counts as one read, and returns the current state either way - a timeout is an answer, not an error.
copyleaks_get_results - Get scan results
Read-only
Returns a completed scan’s scores, counts, sources, and matched text.
copyleaks_get_flagged_segments - List flagged segments in document order
Read-only
Returns every flagged part of a document in the order it appears, rather than grouped under the sources they matched. Use this to go through a document start to finish; use copyleaks_get_results to ask about a particular source.
Each segment carries its exact text, its type (Exact match, Minor changes, Paraphrased, AI content, or AI phrases), and - for a match - which source it overlaps and what that source says.
Past scans
copyleaks_search_scans - Search past scans
Read-only
Searches the scans you own. Use it to find a scan you are describing rather than naming - “the one from June that scored over 30%.”
Search matches scan names only - no filter by date, status, score, type or folder. For a threshold, sort by score and page until it drops below; for dates or folders, page through and narrow yourself.
Each row carries the scan’s
scanType - Text, File, Web page or Image - and its detections, so you can narrow what comes back once you have it.
copyleaks_get_scan - Get one scan
Read-only
Returns one scan’s title, date, type, score, and status. Use copyleaks_get_results for what it found.
Scan profiles
copyleaks_get_profiles - Get scan profiles
Read-only
Returns your scan profiles and their settings. A scan profile is a saved set of scan settings you reuse by name - the same profiles you see in Copyleaks Scan Settings.
copyleaks_create_profile - Create a scan profile
Write
Creates a new profile from settings described in plain language, and returns what was saved. Setting names are the app’s own:
If a setting is not included on your account, it is left out, the rest of the profile is saved, and you are told which setting and whether it is an add-on or part of a plan.
Creating a profile never changes which profile is your account default.