Create moderation
POST
https://api.openai.com/v1/moderationsGiven a input text, outputs if the model classifies it as violating OpenAI's content policy.
Related guide: Moderations
Classifies if text violates OpenAI's Content Policy
Request
Header Params
Authorization
string
optional
Example:
Bearer {{YOUR_API_KEY}}
Body Params application/json
input
string
required
The input text to classify
model
string
required
Two content moderations models are available: text-moderation-stable
and text-moderation-latest
. The default is text-moderation-latest
which will be automatically upgraded over time. This ensures you are always using our most accurate model. If you use text-moderation-stable
, we will provide advanced notice before updating the model. Accuracy of text-moderation-stable
may be slightly lower than for text-moderation-latest
.
Example
{
"input": "I want to kill them."
}
Request samples
Responses
Create moderation(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
id
string
required
model
string
required
results
array [object {3}]
required
categories
object
optional
category_scores
object
optional
flagged
boolean
optional
ExampleCreate moderation
{
"id": "modr-5MWoLO",
"model": "text-moderation-001",
"results": [
{
"categories": {
"hate": false,
"hate/threatening": true,
"self-harm": false,
"sexual": false,
"sexual/minors": false,
"violence": true,
"violence/graphic": false
},
"category_scores": {
"hate": 0.22714105248451233,
"hate/threatening": 0.4132447838783264,
"self-harm": 0.005232391878962517,
"sexual": 0.01407341007143259,
"sexual/minors": 0.0038522258400917053,
"violence": 0.9223177433013916,
"violence/graphic": 0.036865197122097015
},
"flagged": true
}
]
}
Last modified: a year ago