Code Plagiarism & Similarity API

Final Step: Running the check

By default all checks will run Peer check, meaning that two files are required to start checking. Once you have uploaded more than 2 files you can also run additional tests on the submissions, such as database and web check. We encourage reading more about the different test types.

When sending the request, we will need to send the check_id to start:

You can also optionally run additional checks by sending:

				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)

Notice that there is now a job_id assosiated with the check. This can be used to listen in realtime to the checking progress through SocketIO (documentation on this will be written soon).

				{
    "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