Code Plagiarism & Web Similarity API

Final Step: Running the check Web Plagiarism or Group Similarity

By default, all checks will run Web and Group Similarity, meaning that one ZIP file uploaded is required to start checking. For group similarity checking, you can run up to 500 ZIP files in a Group Similarity check, with a 10MB maximum size for each file, containing parsable code in the specified programming language. We encourage reading more about the different test types.

When sending the request, include the required and optional parameters as follows:

To start a Group similarity only check (free MOSS alternative), you may use the following optional parameters:

You may also specify a custom engine type for base code detection:

Find all the checking engine types below:

ID: 1 - Web Plagiarism and Group Similarity
ID: 3 - Small Files Checker
ID: 4 - Peer Focused Checker
ID: 6 - Large Volume Group Similarity
ID: 7 - Low Consumption
ID: 8 - Deep Check (Highly Experimental)
ID: 9 - Group Similarity Only
ID: 10 - Group Similarity Only (Auto-detect base code)
ID: 11 - Web Plagiarism and Group Similarity (Auto-detect base code)
ID: 12 - Group Similarity Only (30% tolerance)
ID: 13 - Group Similarity Only (Optimized for use with Codequiry Libraries)
ID: 14 - Web Plagiarism and Group Similarity (Optimized for use with Codequiry Libraries)

Free users get 30 checking quota (via API, no card is required) included, while premium users enjoy a quota of 1,700 checks/mo, upgradeable to 20,000 from the billing page. By default, all checks run as Web Similarity unless specified otherwise in the above instructions.

        curl -X POST 'https://codequiry.com/api/v1/check/start?check_id=YOUR_CHECK_ID&webcheck=1' \
            -H 'apikey:  YOUR_API_KEY_HERE '
        

            

                cURL Command
            
        
    

Sample Response (JSON Object)

Job (job_id) listening is phased out and you can manually poll the status as it’s updated in real-time as the check is started.

        {
            "check": {
                "id": 2000,
                "name": "Java",
                "created_at": "2019-05-31 15:54:15",
                "updated_at": "2019-05-31 16:02:29",
                "status_id": 6,
                "job_id": 8860
            },
            "status": "Checking in progress",
            "dbcheck": false,
            "webcheck": true,
            "submission_count": 3,
            "dashURL": "https://dashboard.codequiry.com/course/10970/assignment/2000"
        }
        

            

                JSON Array
            
        
    

Error Format Response (422 error)

        {
            "error": "Invalid check_id provided"
        }
        

            

                JSON Array
            
        
    

What's next

For optimal understanding of API usage, we recommend following this guide.

• 7. Get Checking Status