Run

Quick check (all-in-one)

Creates a check, uploads files, and starts analysis in a single authenticated call. Distinct from the public website Quick Check widget.

post/check/quick

Request

  • Base URL: https://codequiry.com/api/v1
  • URL: https://codequiry.com/api/v1/check/quick
  • Auth: API key in header apikey

Response

Created and started

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Check created, files uploaded, and analysis started successfully.",
  "data": {
    "check_id": 12345,
    "check_name": "CS-201 Assignment 4",
    "language": "Java (.java)",
    "language_id": 13,
    "status": "Processing",
    "status_id": 7,
    "test_type": 1,
    "submissions": {
      "uploaded": 28,
      "total": 28,
      "details": [
        {
          "id": 90271,
          "filename": "nowak_alice_a4",
          "file_size": 10874,
          "status_id": 2,
          "created_at": "2026-08-11 09:14:02"
        }
      ]
    },
    "failed_uploads": [
      {
        "file": "duffy_erin_a4.rar",
        "error": "The files.3 must be a file of type: zip."
      }
    ],
    "detection_settings": {
      "web_check": true,
      "github_check": true,
      "stackoverflow_check": true,
      "gist_check": true
    },
    "check_url": "https://dashboard.codequiry.com/course/678/assignment/12345/overview",
    "execution_time_ms": 4182
  },
  "next_steps": {
    "poll_status": "Use GET /check/get with check_id=12345 to monitor progress",
    "get_results": "Once status is 'Completed', use POST /check/overview with check_id=12345"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.