Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json

image

image
string
required

Url of an image or base 64 encoded image string

Minimum string length: 1
Example:

"This is a very cool api"

options
object

Response

Response of the moderated image

summary
object
required
isSafe
boolean
required

Whether the image is considered safe

Example:

true

confidence
number
required

Confidence of the safety of the image from 1-100

Example:

90

description
string
required

A short description of what the image depicts

Example:

"This is a description"

riskScores
object
required
topics
string[]
required

General topics the image depicts, lowercase and no punctuation

Example:
nsfwCategories
object[]
required
Example:
suggestedActions
object
required
hash
string
required

SHA-256 hash of the image

Example:

"93a08bd10cd367bf83f12ba6590fcaef2f8deec8a47ce4ce88a15c7dda325ffa"

meta
any | null

The metadata of the request

Example:

"This is the metadata"