Citation Checker

# macOS
brew install curl

# Ubuntu/Debian
sudo apt-get install curl

# Windows - download from https://curl.se

pip install copyleaks

npm install plagiarism-checker

Install-Package Copyleaks

composer require copyleaks/php-plagiarism-checker

gem install plagiarism-checker

<!-- Add to your pom.xml (requires Java 11+) -->
<dependency>
    <groupId>com.copyleaks.sdk</groupId>
    <artifactId>copyleaks-java-sdk</artifactId>
    <version>5.1.0</version>
</dependency>

POST https://id.copyleaks.com/v3/account/login/api

Headers
Content-Type: application/json

Body
{
    "email": "[email protected]",
    "key": "00000000-0000-0000-0000-000000000000"
}

export COPYLEAKS_EMAIL="[email protected]"
export COPYLEAKS_API_KEY="your-api-key-here"

curl --request POST \
  --url https://id.copyleaks.com/v3/account/login/api \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data "{
    \"email\": \"${COPYLEAKS_EMAIL}\",
    \"key\": \"${COPYLEAKS_API_KEY}\"
  }"

from copyleaks.copyleaks import Copyleaks

EMAIL_ADDRESS = "[email protected]"
API_KEY = "your-api-key-here"

# Login to Copyleaks
auth_token = Copyleaks.login(EMAIL_ADDRESS, API_KEY)
print("Logged successfully!\nToken:", auth_token)

const { Copyleaks } = require("plagiarism-checker");

const EMAIL_ADDRESS = "[email protected]";
const API_KEY = "your-api-key-here";
const copyleaks = new Copyleaks();

// Login function
function loginToCopyleaks() {
  return copyleaks.loginAsync(EMAIL_ADDRESS, API_KEY).then(
    (loginResult) => {
      console.log("Login successful!");
      console.log("Access Token:", loginResult.access_token);
      return loginResult;
    },
    (err) => {
      console.error('Login failed:', err);
      throw err;
    }
  );
}

loginToCopyleaks();

import classes.Copyleaks;
import models.response.CopyleaksAuthToken;

String EMAIL_ADDRESS = "[email protected]";
String API_KEY = "00000000-0000-0000-0000-000000000000";

// Login to Copyleaks
try {
    CopyleaksAuthToken authToken = Copyleaks.login(EMAIL_ADDRESS, API_KEY);
    System.out.println("Logged in successfully!");
} catch (Exception e) {
    System.out.println("Failed to login: " + e.getMessage());
    System.exit(1);
}

PUT https://api.copyleaks.com/v3/scans/submit/file/my-scan-id
Content-Type: application/json
Authorization: Bearer <YOUR_AUTH_TOKEN>

{
  "base64": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQu",
  "filename": "paper_with_references.txt",
  "properties": {
    "webhooks": {
      "status": "https://your-server.com/webhook/{STATUS}"
    },
    "scanning": {
      "internet": false
    },
    "references": {
      "validate": true
    }
  }
}

curl -X PUT "https://api.copyleaks.com/v3/scans/submit/file/my-scan-id" \
     -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
           "base64": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQu",
           "filename": "paper_with_references.txt",
           "properties": {
             "webhooks": {
               "status": "https://your-server.com/webhook/{STATUS}"
             },
             "scanning": {
               "internet": false
             },
             "references": {
               "validate": true
             }
           }
         }'

import requests
import base64

# Document content (your text with references)
document_content = "This is a test document with references."
base64_content = base64.b64encode(document_content.encode()).decode('utf-8')

url = "https://api.copyleaks.com/v3/scans/submit/file/my-scan-id"
payload = {
    "base64": base64_content,
    "filename": "paper_with_references.txt",
    "properties": {
        "webhooks": {
            "status": "https://your-server.com/webhook/{STATUS}"
        },
        "scanning": {
            "internet": False
        },
        "references": {
            "validate": True
        }
    }
}
headers = {
    "Authorization": "Bearer <YOUR_AUTH_TOKEN>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const axios = require('axios');

const url = 'https://api.copyleaks.com/v3/scans/submit/file/my-scan-id';
const headers = {
    'Authorization': 'Bearer <YOUR_AUTH_TOKEN>',
    'Content-Type': 'application/json'
};

const data = {
    base64: "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQu",
    filename: "paper_with_references.txt",
    properties: {
        webhooks: {
            status: "https://your-server.com/webhook/{STATUS}"
        },
        scanning: {
            internet: false
        },
        references: {
            validate: true
        }
    }
};

axios.put(url, data, { headers })
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

import classes.Copyleaks;
import models.submissions.CopyleaksFileSubmissionModel;
import models.submissions.properties.*;
import java.util.Base64;
import java.nio.charset.StandardCharsets;

String scanId = "my-scan-id";
String base64Content = Base64.getEncoder().encodeToString("This is a test document with references.".getBytes(StandardCharsets.UTF_8));

// Create submission properties
SubmissionProperties properties = new SubmissionProperties(new SubmissionWebhooks("https://your-server.com/webhook/{STATUS}"));

// Disable plagiarism so the scan runs references-only
SubmissionScanning scanning = new SubmissionScanning();
scanning.setInternet(false);
properties.setScanning(scanning);

// Turn the citation checker on
SubmissionReferences references = new SubmissionReferences();
references.setValidate(true);
properties.setReferences(references);

// Create and submit the file
CopyleaksFileSubmissionModel submission = new CopyleaksFileSubmissionModel(base64Content, "paper_with_references.txt", properties);

Copyleaks.submitFile(authToken, scanId, submission);
System.out.println("Scan submitted with the citation checker.");