---
title: "Start a check. Free. With a key the status address answers with the full report and the check is saved to that organization's dashboard; with no key it answers with the summary"
method: POST
path: "/api/v1/beacon/checks"
tags: ["Beacon"]
---

# Start a check. Free. With a key the status address answers with the full report and the check is saved to that organization's dashboard; with no key it answers with the summary

`POST /api/v1/beacon/checks`

## Request

- Base URL: `https://overwing.ai`
- URL: `https://overwing.ai/api/v1/beacon/checks`
- Auth: one of:
  - none
  - HTTP bearer

## Request body

- object
  - `url` string, required: The site to check: a domain or an https URL. Public sites on the default port only

## Response `201`

Started; the check runs when status_url is first asked for

- object
  - `id` string
  - `url` string
  - `status` 'queued'
  - `price_usd` 0
  - `access` 'full' | 'summary': What status_url will answer with for this caller
  - `status_url` string
  - `report_url` string
  - `saved_to_dashboard` boolean
  - `next` string
  - `full_report` object: Present with no key: how to open the full report

## Other responses

- `400`: url is missing or not a public https address
- `401`: A key was sent and is not valid
- `422`: The site did not answer
- `429`: The daily limit of free checks is spent: 5 per address with no key, 30 per organization with one

---

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