Developer API
Code Plagiarism
Detection API
Build plagiarism detection into your apps. Check code against 20+ billion sources.
const response = await fetch('https://codequiry.com/api/v1/check', {
method: 'POST',
headers: { 'apikey': 'YOUR_API_KEY' },
body: formData
});
// Check created!
CHECK SUMMARY API
Get Check Summary
Retrieve a high-level summary of a plagiarism check including aggregate statistics, plagiarism scores, AI detection metrics, and processing information.
API Endpoint
POST https://codequiry.com/api/v1/check/summary
Authentication
Include your API key in the request header:
apikey: YOUR_API_KEY_HERE
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
check_id |
Integer | Required | The unique identifier of the check to summarize |
Success Response
HTTP Status: 200 OK
{
"check_id": 2810,
"check_name": "Python Assignment - Week 5",
"status": "Completed",
"status_id": 4,
"submission_count": 25,
"completed_submissions": 25,
"plagiarism_stats": {
"avg": 34.5,
"max": 89.2,
"min": 2.1
},
"ai_detection_stats": {
"avg": 22.3,
"max": 78.5
},
"flagged_submissions": 8,
"processing_time_seconds": 145,
"created_at": "2024-01-15 14:30:22",
"updated_at": "2024-01-15 14:32:47"
}
Response Fields
- check_id — The check identifier
- check_name — Human-readable check name
- status / status_id — Current check status
- submission_count — Total submissions in the check
- completed_submissions — Submissions that have been fully analyzed
- plagiarism_stats.avg — Average plagiarism score across all submissions (%)
- plagiarism_stats.max — Highest plagiarism score found (%)
- plagiarism_stats.min — Lowest plagiarism score found (%)
- ai_detection_stats.avg — Average AI detection probability (%)
- ai_detection_stats.max — Highest AI detection probability (%)
- flagged_submissions — Number of submissions flagged for high similarity
- processing_time_seconds — Total analysis time in seconds
- created_at / updated_at — Timestamps in UTC
Error Responses
401 Unauthorized
Invalid or missing API key.
404 Not Found
Check not found or does not belong to your account.
409 Conflict
Check is still being processed. Summary is only available for completed checks (status_id 4).
Code Examples
cURL
curl -X POST "https://codequiry.com/api/v1/check/summary" \
-H "apikey: YOUR_API_KEY_HERE" \
-d "check_id=2810"
JavaScript
const response = await fetch('https://codequiry.com/api/v1/check/summary', {
method: 'POST',
headers: {
'apikey': 'YOUR_API_KEY_HERE',
'Content-Type': 'application/json'
},
body: JSON.stringify({ check_id: 2810 })
});
const summary = await response.json();
console.log(`Check: ${summary.check_name}`);
console.log(`Submissions: ${summary.submission_count}`);
console.log(`Avg Plagiarism: ${summary.plagiarism_stats.avg}%`);
console.log(`Max Plagiarism: ${summary.plagiarism_stats.max}%`);
console.log(`Flagged: ${summary.flagged_submissions}`);