Scan Endpoint
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
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).
The same as the X-UI-Lang header, for requests a browser makes without custom headers. If both are sent, lang wins.
Headers
Language of the answer's message fields (a language code such as en or es; only the part before any - is used). Without it, the answer is English as always and error bodies carry no message.
Response
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).
Changes
No recorded changes to this operation across all 1 revision of this API.