POST v2/academic/create-by-file

Scan files to find where the content has been used elsewhere and check its originality. Using create-by-file you can scan various file types for plagiarism and identify copied content. See supported file types here. When submitting multiple files in the same request they will also be compared to each other.

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 request 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

Provide the byte array of the input file or files. The maximum allowed file size is 25MB and you can add up to 100 files to the HTTP request. Please see here the supported file types.

Response Information

Resource Description

Name Description Type Additional information
Success

An array that includes all the files from your request that have been successfully scanned.

Array

None.

ProcessId

The Id of the new scan request

globally unique identifier

None.

CreationTimeUTC

The request's creation time.

string

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

Errors

An array that includes all the files from your request that have not been successfully scanned.

Array

None.

ErrorCode

The error code of the specific failed file. See full list.

int

None.

ErrorMessage

the error message of the specific failed file

string

None.

FileName

The name of the file

string

None.

Response Formats

application/json, text/json

Sample:
{
   "Success":[
      {
         "Filename":"file1.docx",
         "ProcessId":"ccac6807-5577-4f95-ae78-1a906816e8e7",
         "CreationTimeUTC":"04/04/2017 08:49:10"
      },
      {
         "Filename":"file2.docx",
         "ProcessId":"59c5f785-0db7-44e1-b8e7-557a33331345",
         "CreationTimeUTC":"04/04/2017 08:49:10"
      }
   ],
   "Errors":[
      {
         "ErrorCode":14,
         "ErrorMessage":"The submitted file is invalid.",
         "Filename":"file3.docx"
      }
   ]
}

Deprecated Versions