---
title: "The report for a check, as JSON or markdown, inline or as a file. The first request runs the check. With a key, the full report; with no key, the summary of a free check (\"access\" says which). A check paid over x402 is open in full to whoever holds its id"
method: GET
path: "/api/v1/beacon/checks/{id}"
tags: ["Beacon"]
---

# The report for a check, as JSON or markdown, inline or as a file. The first request runs the check. With a key, the full report; with no key, the summary of a free check ("access" says which). A check paid over x402 is open in full to whoever holds its id

`GET /api/v1/beacon/checks/{id}`

## Request

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

## Path parameters

- `id` string, required

## Query parameters

- `format` 'json' | 'md'
- `download` '1'

## Response `200`

The full report (access: full), or with no key the summary of a free check (access: summary): the same fields without checks, with the first of top_fixes, plus counts and full_report

- BeaconReport
  - `id` string
  - `url` string
  - `host` string
  - `scanned_at` string, date-time
  - `score` integer
  - `verdict` 'yes' | 'partly' | 'no': Is the product reachable by agents
  - `summary` string
  - `categories` object[]
    - `key` 'find' | 'read' | 'use'
    - `title` string
    - `question` string
    - `answer` 'yes' | 'partly' | 'no'
    - `points` integer
    - `max` integer
  - `checks` object[]
    - `id` string
    - `category` 'find' | 'read' | 'use'
    - `title` string
    - `status` 'pass' | 'warn' | 'fail'
    - `points` integer
    - `max` integer
    - `detail` string: What was found
    - `fix` string: What to change. Absent when the check passed
    - `evidence` string: The address that was read
  - `top_fixes` object[]
    - `check` string
    - `fix` string
    - `gain` integer: Points the fix is worth
  - `judged` boolean: False when the model judgments could not be made; their checks are then left out
  - `duration_ms` integer
  - `requests` integer

## Other responses

- `202`: Running; ask again in a few seconds (Retry-After)
- `401`: A key was sent and is not valid
- `404`: No such check

---

[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)