Assess Grammar & Writing Quality

# macOS
brew install curl

# Ubuntu/Debian
sudo apt-get install curl

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

pip install copyleaks

npm install copyleaks

dotnet add package Copyleaks

# Or, in the Visual Studio Package Manager Console:
# Install-Package Copyleaks

composer require copyleaks/copyleaks

gem install copyleaks

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

go get github.com/Copyleaks/[email protected]

cargo add copyleaks@2
cargo add tokio --features macros,rt-multi-thread

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("copyleaks");

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
CopyleaksAuthToken authToken = null;
try {
    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);
}

using System;
using Copyleaks.SDK.V3.API;

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

// Login to Copyleaks
var identityClient = new CopyleaksIdentityApi();
var loginResponse = await identityClient.LoginAsync(EMAIL_ADDRESS, API_KEY);
string authToken = loginResponse.Token;
Console.WriteLine("Logged in successfully!");

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Copyleaks\Copyleaks;

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

// Login to Copyleaks
$copyleaks = new Copyleaks();
$authToken = $copyleaks->login($EMAIL_ADDRESS, $API_KEY);
echo "Logged in successfully!\n";

require 'copyleaks'

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

# Login to Copyleaks
copyleaks = Copyleaks::API.new
auth_token = copyleaks.login(EMAIL_ADDRESS, API_KEY)
puts "Logged in successfully!"

POST https://api.copyleaks.com/v1/writing-feedback/my-scan-1/check

Headers
Authorization: Bearer <YOUR_AUTH_TOKEN>
Content-Type: application/json

Body
{
  "text": "Copyleaks is a online plagarism detector that helps schools, business and content creators to make sure thier work is orginal. It scans textes from internet and databasis to find similerities. The tool is fast, accurate and supports multipal languages. However, some times it gives false possitives, so users should double check results. Overall, its a usefull platform for mantaining content integrity.",
  "sandbox": true
}

curl -X POST "https://api.copyleaks.com/v1/writing-feedback/my-scan-1/check" \
     -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
           "text": "Copyleaks is a online plagarism detector that helps schools, business and content creators to make sure thier work is orginal. It scans textes from internet and databasis to find similerities. The tool is fast, accurate and supports multipal languages. However, some times it gives false possitives, so users should double check results. Overall, its a usefull platform for mantaining content integrity.",
           "sandbox": true
         }'

from copyleaks.copyleaks import Copyleaks
from copyleaks.models.submit.writing_assistant_document import WritingAssistantDocument

scan_id = "my-python-scan"
sample_text = "Hello world, this is a test."

submission = WritingAssistantDocument(sample_text)
submission.set_sandbox(True)

response = Copyleaks.WritingAssistantClient.submit_text(auth_token, scan_id, submission)
print(f"Overall score: {response.score.corrections.overall_score}")

const { Copyleaks, CopyleaksWritingAssistantSubmissionModel } = require('copyleaks');

async function checkWriting() {
    try {
        // Initialize Copyleaks
        const copyleaks = new Copyleaks();

        // Login to get the authentication token.
        // Replace with your email and API key.
        const loginResult = await copyleaks.loginAsync('[email protected]', 'YOUR_API_KEY');

        const scanId = `writing-scan-${Date.now()}`;
        
        // The text to be checked
        const textToCheck = "This is a sample text to check for grammar and writing quality.";

        // Create a submission model
        const submission = new CopyleaksWritingAssistantSubmissionModel(textToCheck);
        submission.sandbox = true; // Use sandbox for testing

        // Submit the text for analysis
        const response = await copyleaks.writingAssistantClient.submitTextAsync(loginResult, scanId, submission);
        console.log("Writing analysis results:", response);

    } catch (error) {
        console.error("An error occurred:", error);
    }
}

checkWriting();

import classes.Copyleaks;
import models.submissions.writingassistant.CopyleaksWritingAssistantSubmissionModel;
import models.response.writingassitant.WritingAssistantResponse;

String scanId = "my-java-scan";
String sampleText = "Hello world, this is a test.";

CopyleaksWritingAssistantSubmissionModel submission = new CopyleaksWritingAssistantSubmissionModel(sampleText);
submission.setSandbox(true);

WritingAssistantResponse response = Copyleaks.writingAssistantClient.submitText(authToken, scanId, submission);
System.out.println("Grammar score: " + response.getScore().getCorrections().getGrammarCorrectionsScore());

using System;
using Copyleaks.SDK.V3.API;
using Copyleaks.SDK.V3.API.Models.Requests.WritingAssistant;

// authToken comes from the login step
var scanId = "my-csharp-scan";
var sampleText = "Hello world, this is a test.";

var submission = new WritingAssistantDocument
{
    Text = sampleText,
    Sandbox = true
};

var writingAssistantClient = new CopyleaksWritingAssistantApi();
var response = await writingAssistantClient.SubmitTextAsync(scanId, submission, authToken);
Console.WriteLine("Overall score: " + response.Score.Corrections.OverallScore);

<?php
use Copyleaks\CopyleaksWritingAssistantSubmissionModel;

// $copyleaks and $authToken come from the login step
$scanId = "my-php-scan";
$sampleText = "Hello world, this is a test.";

$submission = new CopyleaksWritingAssistantSubmissionModel($sampleText);
$submission->sandbox = true;

$response = $copyleaks->writingAssistantClient->submitText($authToken, $scanId, $submission);
print_r($response);

require 'copyleaks'

# copyleaks and auth_token come from the login step
scan_id = "my-ruby-scan"
sample_text = "Hello world, this is a test."

submission = Copyleaks::WritingAssistantSubmissionModel.new(sample_text)
submission.sandbox = true

response = copyleaks.writing_assistant_client.submit_text(auth_token, scan_id, submission)
puts response