Skip to main content
GET
Get a text moderation batch
Requires the job:read scope. Requests without this scope receive a 403 FORBIDDEN response. See authentication.
The batch status stays processing until every item is completed or failed. Each item shows its own decision as soon as it has one. Match items by key, not by position: the response orders them by key. A batch ID that does not exist, or that belongs to a different account, returns 404 BATCH_NOT_FOUND.

Authorizations

Authorization
string
header
required

API key from the Omnifence dashboard

Path Parameters

batch_id
string<uuid>
required

Response

200 - application/json

Default Response

type
enum<string>
required
Available options:
text_batch
batch_id
string<uuid>
required
status
enum<string>
required

completed once every item is completed or failed, in the same step that sends the batch webhook.

Available options:
processing,
completed
created_at
string<date-time>
required
completed_at
null | string<date-time>
required
items
object[]
required

One decision for each item, ordered by key. Match items by key.