This guide will walk you through installing the official Java SDK and running your first scan. In just a few minutes, you’ll be able to check content for plagiarism, AI-generated text, moderation and more directly from your Java application. Before you start, ensure you have the following:

Get Started

1

Installation

The SDK requires Java 11 or higher. Add the official copyleaks-java-sdk dependency to your project’s pom.xml file.
pom.xml
  <dependency>
      <groupId>com.copyleaks.sdk</groupId>
      <artifactId>copyleaks-java-sdk</artifactId>
      <version>5.1.0</version>
  </dependency>
2

Quick Example: Scan Text

Remember to replace the placeholder credentials and webhook URL with your actual values.
ScanExample.java
import classes.Copyleaks;
import models.response.CopyleaksAuthToken;
import models.submissions.CopyleaksFileSubmissionModel;
import models.submissions.properties.SubmissionProperties;
import models.submissions.properties.SubmissionWebhooks;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.Random;

public class ScanExample {
    // --- Your Credentials ---
    private static final String EMAIL_ADDRESS = "YOUR_EMAIL_ADDRESS";
    private static final String KEY = "YOUR_API_KEY";
    private static final String WEBHOOK_URL = "https://your-server.com/webhook/{STATUS}";
    // --------------------

    public static void main(String[] args) {
        CopyleaksAuthToken token;
        try {
            // Log in to the Copyleaks API
            System.out.println("Authenticating...");
            token = Copyleaks.login(EMAIL_ADDRESS, KEY);
            System.out.println(" Logged in successfully!");

            // Prepare your content for scanning
            System.out.println("Submitting text for scanning...");
            String textToScan = "Hello world, this is a test.";
            String base64Content = Base64.getEncoder().encodeToString(textToScan.getBytes(StandardCharsets.UTF_8));
            String filename = "test.txt";
            String scanId = Integer.toString(new Random().nextInt(100000));
            
            // Configure the scan
            SubmissionWebhooks webhooks = new SubmissionWebhooks(WEBHOOK_URL);
            SubmissionProperties submissionProperties = new SubmissionProperties(webhooks);
            submissionProperties.setSandbox(true); // Turn on sandbox mode for testing

            CopyleaksFileSubmissionModel submissionModel = new CopyleaksFileSubmissionModel(base64Content, filename, submissionProperties);

            // Submit the scan to Copyleaks
            Copyleaks.submitFile(token, scanId, submissionModel);
            System.out.println(" Scan submitted successfully! Scan ID: " + scanId);
            System.out.println("You will be notified via your webhook when the scan is complete.");

        } catch (Exception e) {
            System.out.println(" An error occurred:");
            e.printStackTrace();
        }
    }
}
3

Understanding the Code

The example code performs four main actions to submit a scan:
  1. Login: It authenticates with your email and API key to get a secure CopyleaksAuthToken object, which is required for all subsequent requests.
  2. Prepare Content: It takes a simple string of text and encodes it into Base64 format.
  3. Configure Scan: It creates a SubmissionProperties object containing SubmissionWebhooks to define the scan’s behavior. We enable sandbox mode for safe testing and provide the webhook URL.
  4. Submit for Scanning: It creates a CopyleaksFileSubmissionModel with the content and properties, then sends it to the Copyleaks API. The process is asynchronous; Copyleaks will notify your webhook URL once the scan is complete.

Next Steps

GitHub Repository

Check the official SDK repository on GitHub for more examples and details.

Maven Central

View the official package on the Maven Central Repository to see all available versions.

Check for Plagiarism

Detect plagiarism in text documents using the Copyleaks API. Search billions of sources to find unoriginal content.

Detect AI-Generated Content

Detect AI-generated text via sync or async API calls. This guide covers sync detection, see the Authenticity API Guide for async.

Assess Grammar and Writing Quality

Get writing and grammar suggestions via API. Authenticate, submit text, and access full details in the docs.

Moderate Text

Scan and moderate text content for unsafe or policy-relevant material across 10+ categories.