Checks

Create a check

Creates an empty check. Only name is required; language and test_type are optional and default to 13 and 1 respectively.

post/check/create

Request

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

Request body

namestring required

Check name.

languageinteger

Language id from GET /languages. Use 999 for Auto Detect; an unknown/invalid id falls back to Auto Detect instead of returning an error.

test_typeinteger

Engine id from GET /test-types.

ai_runboolean

Run AI-generated-code detection on this check. Accepts true/false/1/0.

base_code_detectionboolean

Detect shared base/boilerplate (starter) code.

callback_urlstring uri

Webhook destination for this check. Codequiry POSTs a signed JSON payload here when the check completes or fails, so you do not have to poll. Must be a publicly reachable http(s) URL - loopback, private and link-local addresses are rejected with 422. Overrides the account-level webhook URL set in Dashboard -> API Keys. See the Webhooks section of the API description.

Example request

{
  "name": "CS-201 Assignment 4",
  "callback_url": "https://example.edu/hooks/codequiry"
}

Response

Created check

idinteger

Save this - it is the check_id every other endpoint takes.

namestring
status_idinteger

Always 1 (new) on creation.

language_idinteger
test_typeinteger
ai_runinteger
base_code_detectioninteger
job_idinteger

0 until the check is started.

created_atstring
updated_atstring

Example response

{
  "id": 12345,
  "name": "CS-201 Assignment 4",
  "status_id": 1,
  "language_id": 13,
  "test_type": 1,
  "ai_run": 1,
  "created_at": "2026-08-11 09:14:02",
  "updated_at": "2026-08-11 09:14:02"
}

Changes

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