---
title: "Scan Endpoint"
method: POST
path: "/api/scan"
tags: ["scan"]
---

# Scan Endpoint

`POST /api/scan`

## Request

- Base URL: `https://api.scanforai.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.scanforai.com/api/scan`
- Auth: none declared

## Query parameters

- `format` string
- `use_model` boolean
- `include_fixes` boolean
- `background` boolean
- `text_language` string, nullable: The language the text is written in: "auto" (the default) or the code of a language this api scores, from /api/config `languages` (for example "en" or "es"). Also accepted as `text_language` in a JSON body. A text clearly in another language is still read as that language, and the result says so in `text_language` (`picked`, `read_as`, `applied`).
- `lang` string

## Headers

- `X-UI-Lang` string

## Response `200`

The scan result. It carries `outcome` (`scored`, `too_short`, `unsupported_language`, `deep_required` or `deep_failed`) and an `i18n` block (see `I18nBlock`). When the request named a `text_language` other than `auto`, it also carries `text_language`: `picked` (the code asked for), `read_as` (the language the text was read in, null when it was not scored for language reasons) and `applied` (false when the text said otherwise, or the language is not available right now).

- unknown

## Other responses

- `422`: Validation Error

---

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