Twelve tools, grouped by the job they do.

​
Scanning

Write · spends creditsRuns a scan and returns a handle to check on. Accepts pasted text, a web address, files, or an uploaded image.detectors is what you ask Copyleaks to use. detections in the results is what actually ran - they differ when, for example, text falls under the 350-word AI minimum.Returns immediately with a scan that is still running. Follow with copyleaks_scan_status, then copyleaks_get_results.
Write · spends creditsRuns 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.
Write · costs no creditsReturns 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

Read-onlyReturns whether a scan is running, complete, or failed. While running, may include how far along it is as a percentage.No time estimate is available - a percentage says how far along the scan is, not how long remains. There is no notification when a scan finishes; checking here is the only way to find out. Checking again before anything has changed returns the same answer, so wait between checks.
Read-onlyReturns a completed scan’s scores, counts, sources, and matched text.
Read-onlyReturns 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

Read-onlySearches the scans you own. Use it to find a scan you are describing rather than naming - “the one from June that scored over 30%.”detection and submitted_as answer different questions. “Find my AI scans” is detection. “Find the PDFs I scanned” is submitted_as.
Older listing rows carry a whole-number score - 23 where the scan itself holds 23.1, truncated rather than rounded. Rows recorded more recently carry the decimal. Where the exact figure matters, read the scan with copyleaks_get_scan or copyleaks_get_results.
A row also carries totalWords, which is what separates a detector ran and found nothing from it never ran - AI Detection does not run below 350 words, so a 0 without a word count means either. Rows recorded before this was stored report it as null.
Read-onlyReturns one scan’s title, date, type, score, and status. Use copyleaks_get_results for what it found.

​
Scan profiles

Read-onlyReturns 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.
WriteCreates 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.
WriteChanges named settings on an existing profile. Settings you do not name are left as they are. Returns the full profile as saved.

​
Account

Read-onlyReturns your credit balance, your plan, and which settings this account does not include - each marked as an add-on or as part of a plan.This is the only place credits appear. Buying credits and changing plans are done in your Copyleaks account, not through this connector.