Skip to main content
POST
cURL
Requires the moderate:text scope. Requests without this scope receive a 403 FORBIDDEN response. See authentication.
A batch holds 1 to 99 items. Each text is limited to 20,000 characters, and each key must be unique in the batch. An invalid batch is refused with 400 before any job is created or billed. See batch text moderation.
One batch request counts as one request against your rate limit. Each item is billed as one text moderation job.

Authorizations

Authorization
string
header
required

API key from the Omnifence dashboard

Body

application/json
items
object[]
required

The texts to check, 1 to 99. Each item is checked on its own and gets its own decision.

Required array length: 1 - 99 elements
webhook_url
string<uri>

HTTPS URL that receives one webhook when every item has a final decision or has failed. Falls back to your registered webhook. Items send no webhook of their own.

Response

Default Response

batch_id
string<uuid>
required
status
enum<string>
required
Available options:
processing
items
object[]
required

One entry for each submitted item, in the order you sent them.