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

Login to the Copyleaks API using your email and API key.

Once logged in, you will get back a login token that will be used to authenticate yourself when calling the other API methods.

After generating the login-token, you should attach the token for your next calls. Attaching the endpoint is done by adding this header to your calls:

Authorization: Bearer TOKEN

A generated token is valid for 48 hours. Within this period of time, you can use it multiple times. Before attaching the Authorization header for your next endpoint calls, make sure that the token has not expired. If it expired, generate a new one.

Handle tokens carefully

The Copyleaks API token should be treated as a password. Attackers, who can gain access to this token, can access your private information and modify it.

API Rate Limit

12 requests per account/15 minutes

If you exceed the API limit, authentication will be blocked for 5 minutes (Rate Limit Exceeded HTTP 429 - Too Many Requests).

Request

Headers

Content-Type: application/json
Accept: application/json

Body

email string required

Your Copyleaks account email address

key string required

Your Copyleaks account API key (UUID format)

Responses

Success

200

200 OK

The command was executed successfully.

Response Schema

The response contains the following fields:

access_token string

The authentication token for API access.

.issued string

The date and time when the token was issued.

.expires string

The date and time when the token will expire.

Example Response

A typical response from this endpoint:

{
  "access_token": "ACLNSKNSDAACCAJANCOIUiausoo_saidjaskldjoa...",
  ".issued": "2018-11-24T16:15:38.2431255+02:00",
  ".expires": "2018-11-26T16:15:38.2431255+02:00"
}

400

400 Bad Request

Bad Request - Invalid request format or missing required fields

Example Response

A typical response from this endpoint:

{
  "Key": [
    "The key field is required."
  ]
}

401

401 Unauthorized

Unauthorized - Invalid email or API key

Example Response

A typical response from this endpoint:

{
  "message": "Invalid login credentials."
}

429

429 Too Many Requests

Too Many Requests - Rate limit exceeded (blocked for 5 minutes)

Example Response

A typical response from this endpoint:

{
  "error": "Rate limit exceeded",
}

Examples

HTTP

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

Headers
Content-Type: application/json

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

cURL

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}\"
  }"

Python

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)

JavaScript

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

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


async function login() {
    const copyleaks = new Copyleaks();
    const loginResult = await copyleaks.loginAsync(EMAIL_ADDRESS, API_KEY);
    console.log('Logged successfully!\nToken:', loginResult);
    return loginResult;
}

Java

import com.copyleaks.sdk.api.Copyleaks;

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

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