---
title: "Quick check (all-in-one)"
method: POST
path: "/check/quick"
tags: ["Run"]
---

# Quick check (all-in-one)

`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`

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

## Response `201`

Created and started

- QuickCheckResult
  - `success` boolean
  - `message` string
  - `data` object
    - `check_id` integer
    - `check_name` string
    - `language` string
    - `language_id` integer
    - `status` string
    - `status_id` integer
    - `test_type` integer
    - `submissions` object
      - `uploaded` integer
      - `failed` integer
      - `total` integer
      - `details` object[]: The submission rows created by this call.
        - `id` integer
        - `filename` string
        - `file_size` integer
        - `status_id` integer
        - `created_at` string
    - `failed_uploads` object[]: Files rejected during upload. Empty when everything landed.
      - `file` string
      - `error` string
    - `detection_settings` object: Which external corpora this check searches, resolved from webcheck/dbcheck and the engine.
      - `web_check` boolean
      - `github_check` boolean
      - `stackoverflow_check` boolean
      - `gist_check` boolean
    - `check_url` string
    - `execution_time_ms` number
  - `next_steps` object: Literal follow-up calls, with the new check id already substituted in.
    - `poll_status` string
    - `get_results` string

## Other responses

- `401`: Missing or invalid API key. The API key is checked before any endpoint logic runs, so this is returned for every operation.
- `402`: The account is suspended for an unpaid invoice. Every endpoint returns this until the invoice is paid from the billing dashboard; it is not retryable and the request was not performed.
- `422`: Request validation failed.
- `429`: Rate limit exceeded: more than 60 requests in one minute from this IP. Retry after the number of seconds in the Retry-After header. Successful responses carry X-RateLimit-Limit and X-RateLimit-Remaining too, so you can pace a client without waiting to be refused.
- `500`: Unexpected server error.
- `503`: Analysis services are temporarily offline.

---

[API](https://skmtc.dev/codequiry/apis/codequiry-api.md) · [All operations](https://skmtc.dev/codequiry/apis/codequiry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/codequiry/apis/codequiry-api/revisions/6297e91d9665?raw)