POST v1/academic/create-by-url

Scan URLs to see where it has been used before and check its originality. Using create-by-url you can scan online content, by submitting a URL, for plagiarism and identify infringed content in html and txt formats.

Test the Copyleaks API for free using sandbox mode, receive results in real time using callbacks with the in progress results header and much more. Check out our optional requset headers to see what other options are available when creating a scan request.

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>
Not sure how to generate your login token? read here.

Request Information

Body Parameters

Name Description Type Additional information
Url

URL to scan

URI

Required

Request Formats

application/json, text/json

Sample:
{
  "Url": "http://example.com/page-for-scan"
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
ProcessId

Id of the new scan request

globally unique identifier

None.

CreationTimeUTC

The request's creation time.

string Format: dd/MM/yyyy HH:mm:ss

Response Formats

application/json, text/json

Sample:
{
  "ProcessId": "1074ae9d-ec1c-46ff-adc2-c294abed29f3",
  "CreationTimeUTC": "01/01/2016 18:36:10"
}

Common Errors

Error Code Error Message
1 Bad request. One or several required parameters are missing or incorrect.
15 The submitted URL is invalid!
19 'copyleaks-*' headers are too long (limited to 8192 characters together)!
30 Missing '<header-name>' header value!
31 Bad parameter '<param-name>'!
17 You have no credits. You need to purchase credits in order to complete the request.
5 Failed to download the requested url
10 This file type is not supported. Read more - http://bit.ly/2fqJOqP
6 Cannot complete the scan request because the file is too large. For more information: http://bit.ly/2fqJOqP
14 The submitted file is invalid.
7 Failed reading the submitted text.
11 Not enough text to scan. The minimum text length is 30 characters and at least 6 words.
12 This document is too long (The maximum number of pages allowed is 2000, while this document contains <actual> pages).
13 You don't have enough credits to complete the request (required <expected-credits> credits)!
37 Authorization has been denied for this request.

For more information, see the full errors list.