⏺️Detoxify endpoints

Detoxify is an easy-to-use Python library that detects hateful or offensive language.

Detoxify is an open-source tool to help researchers and practitioners identify potential toxic comments.

Detoxify models are trained to predict toxic comments on 3 Jigsaw challenges: Toxic comment classification, Unintended Bias in Toxic comments, and Multilingual toxic comment classification.

Detoxify endpoints

Detoxify is offered as a set of two standalone text-only API endpoints so that you can avoid the hassle of hosting open-source models.

Any requests you send should meet the requirements listed on Features and requirements.

Please follow the API Authentication instructions first. This will generate a token that is valid for 24 hours and must be used in subsequent API requests.

POST endpoint reference

Queue text for Detoxify classification

This endpoint predicts the Detoxify categories of text.

POST/detoxify/text/

Authorization

JWTBearer

Body

application/x-www-form-urlencoded

callback_urlWebhooks callback URL

text*Text to classify (max 256kb)

modelDetoxify model type

correlation_idAn optional id chosen by the user to correlate requests and responses

Response

200404422

Successful Response

Body

application/json

job_id*Job Id

Request

JavaScriptCurlPython

const response = await fetch('/detoxify/text/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "text": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "job_id": "text"
}

GET endpoint reference

Retrieve the results of a queued Detoxify classification

This endpoint returns the results of a previously queued classify job

GET/detoxify/text/{job_id}

Authorization

JWTBearer

Path parameters

job_id*Job Id

Response

200404422

Successful Response

Body

application/json

status*Status of classification job

resultsClassification results

msgError details

Request

JavaScriptCurlPython

const response = await fetch('/detoxify/text/{job_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200422

{
  "status": {},
  "results": {
    "toxicity": 0,
    "severe_toxicity": 0,
    "obscene": 0,
    "threat": 0,
    "insult": 0,
    "identity_attack": 0,
    "sexual_explicit": 0
  },
  "msg": "text"
}