PUT
Submit a URL to be scanned for plagiarism, AI-generated content, and writing analysis. Copyleaks will crawl the URL, extract its content, and scan it against its vast database and the internet. Once submitted, the scan will be processed, and you can monitor its progress using webhooks or by checking the scan status.
Authentication Required. You need to login with a user and API key in order to access this method. Add this HTTP header to your request:Authorization: Bearer <Your-Login-Token>

Request

Path Parameters

scanId
string
required
A unique scan id provided by you. We recommend you use the same id in your database to represent the scan in the Copyleaks database. This will help you to debug incidents. Using the same ID for the same file will help you to avoid network problems that may lead to multiple scans for the same file. Learn more about the criteria for creating a Scan ID.>= 3 characters <= 36 characters

Headers

Request Body

The request body is a JSON object containing the URL to scan and a properties object to configure the scan.
url
string
required
The URL to be scanned. e.g., https://copyleaks.com
verb
string
Describes the HTTP method that is going to be executed on the specified url. Supported Values: GET, POST, PUT
headers
array[array]
Custom headers for the request. If specified, no Copyleaks headers are attached (otherwise defaults are used). Use Set-Cookie for cookies. Multiple values supported. Example: [["header-key", "header-value"], ...]
properties
object
required
Configuration options for the scan.
For testing purposes, use sandbox mode, which does not consume credits.

Responses

201 Created - The scan was successfully created and is now processing.

Next Steps

Check for AI-Generated Text

Learn how to use Copyleaks to detect AI-generated text, including from the latest models.

Check for Plagiarism

Learn how to use Copyleaks to detect plagiarism by comparing your content against billions of online sources and internal documents.

Check Grammar and Writing Quality

Learn how to use Copyleaks to check for grammar mistakes and get suggestions for improving your writing.