POST v1/businesses/create-by-text

Depreciation

Copyleaks V1 API has been deprectaed and will reach it's end of life on July 1st 2020.

See newer version documentation - Copyleaks V3 API.

Scan raw text to find where it was used before and check its originality. Using create-by-text you can scan text for plagiarism and identify infringed content.

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

Add the plain text to scan to the request body.

Request Formats

application/json, text/json

Sample: 
Text to scan here.

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
EstimatedTimePerCredit

Current predicted estimated scan time per credit.

uint Seconds

Response Formats

application/json, text/json

Sample: 
{
  "ProcessId": "1074ae9d-ec1c-46ff-adc2-c294abed29f3",
  "CreationTimeUTC": "01/01/2016 18:36:10",
  "EstimatedTimePerCredit": 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.
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.