POST
/
moderate
/
image

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string
required

The URL of the image you want to analyze.

authorId
string

The author of the content.

contentId
string

The unique ID of the content in your database.

Required string length: 1 - 100
contextId
string

For example the ID of a chat room or a post

doNotStore
boolean

Do not store the content. The content won't enter the review queue

metadata
object

Any metadata you want to store with the content

Response

200 - application/json
flagged
boolean
required

Whether the content was flagged by any models

labels
object[]
required

The scores of each label

request
object
required

Information about the request

status
string
required

Success if the request was successful

contentId
string

The ID of the content. Only returned if the content was stored.

texts
string[]

The texts found in the image, if the image text model is enabled

Was this page helpful?