POST
/
predict

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
text
string
required

The text to scan. It is required except if you supply a website or a file. Minimum 300 characters. Texts under 600 characters may produce unreliable results and should be avoided. Maximum 100 000 characters per request.

file
string

A file to scan. If you supply a file, the API will scan the content of the file. The file must be in plain .doc or .docx format. The file has priority over the text, so if you give a text and a file, it's the file that will be scanned.

website
string

A website URL to scan. If you supply a website, the API will fetch the content of the website and scan it. The website must be publicly accessible. It's important to know that the website has priority over the text and the file, so if you give a text, a file and a website, it's the website that will be scanned.

version
string

The model version to use. Our latest and most accurate version is "3.0". Using "latest" will make sure you are always using the latest version. Options: 3.0, 2.0, latest. Default: 2.0.

sentences
boolean

Whether the response should include an array of sentences and their scores. Default: true.

language
string

2 letter language code. At this time, the API is only available in english (en), french (fr), spanish (es), portuguese (pt), netherlands (nl) and german (de). default: en. Optional.

Response

200 - application/json
status
integer

This is a standard HTTP status code. A 200 status means the request was successful.

score
integer

A "human" score between 0 and 100. A low score means our system believes that the text is written by AI, and a higher score means that the system believes that the text is written by a Human.

sentences
object

This is an array of sentence objects. Each object contains two fields: text and score. Please note that assessments on smaller samples are less accurate than the general score.

input
string

The type of input we scan based on the input you provided. It can be text | file | website .

credits_used
integer

The credits_used field represents the number of credits consumed for processing your request. Each word that is processed by the API consumes one credit.

credits_remaining
integer

The credits_remaining field shows how many credits you have left in your account after your request has been processed.