Code Plagiarism API BETA

Integrate your existing software with Codequiry's source code plagiarism checker.

API Demonstration

Connect your account to run the live examples.

API: Quick Start
API: Checking submissions
API: Retrieving Results
Available SDK's
General Information

4. Creating Checks

Now that you have learned how to retrieve checking history, it's time to learn how to actually create a check. To understand the checking process better, we will explain the process of checking submissions with the API in this section.

Endpoint for creating a new check

First Step: Creating a new check

Creating a check is the first step in checking submissions. Before we can start uploading or starting checking, we must create a check. We will have to give the check a name and specify the programming language.

When sending the request, we will need to POST two variables:

name - Name the check (string: min 3 char, non-unique)
language - The programming language (string: java, c-cpp, python, csharp, txt) 

				curl -X POST \
  https://codequiry.com/api/v1/check/create?name=Test%20Check&language=python \
  	-H 'Accept: */*' \
  	-H 'apikey:  YOUR_API_KEY_HERE ' 
				

					

						cURL Command
Sample Response (JSON Object) 
				
   {
    "name": "Test Check",
    "status_id": 1,
    "job_id": 0,
    "updated_at": "2019-05-29 19:13:33",
    "created_at": "2019-05-29 19:13:33",
    "id": 2810
}

				

					

						JSON Array
Error Format Response (422 error) 
                {
    "error": "Invalid programming language, must be: [java, c-cpp, python, csharp, txt]"
}
                

                    

                        JSON Array

How to think of the checking process

Now that you have learned how to create a check, it's time to learn how to upload files to the newly created check. Think of creating a check being like creating a folder. Now that you have created the folder, we can now upload submissions to them.

What's next

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

Our Mission

Codequiry aims to achieve an equally fair environment for fields relating to computer science by preventing the use of unoriginal code. The first step to preserving academic integrity and original source code starts here.

Company
Product
From the Blog

© 2019 Codequiry, LLC

Privacy | Terms