Skip to content
RunAPI Developer Docs
EN 中文
API Reference
API Reference

Batch object

An Account-scoped Moderation Batch whose execution lifecycle is reported by the compatible Batch API.

View Markdown

An Account-scoped Moderation Batch whose execution lifecycle is reported by the compatible Batch API.

01

Object fields

JSON body

Stable fields shared by the resource's reusable object.

Batches23 fields
cancelled_atinteger | null
Optional

Unix timestamp when the Batch was cancelled.

cancelling_atinteger | null
Optional

Unix timestamp when cancellation began.

completed_atinteger | null
Optional

Unix timestamp when the Batch completed.

completion_windowstring
Required

Completion window for the Batch.

created_atinteger
Required

Unix timestamp when the Batch was created.

endpointstring
Required

Moderation endpoint processed by the Batch.

error_file_idstring | null
Optional

RunAPI error File ID

errorsobject | null
Optional

Batch validation or execution errors

expired_atinteger | null
Optional

Unix timestamp when the Batch expired.

expires_atinteger | null
Optional

Unix timestamp when the Batch expires.

failed_atinteger | null
Optional

Unix timestamp when the Batch failed.

finalizing_atinteger | null
Optional

Unix timestamp when the Batch entered finalization.

idstring
Required

RunAPI Batch ID.

in_progress_atinteger | null
Optional

Unix timestamp when Batch processing began.

input_file_idstring
Required

RunAPI input File ID.

metadataobject
Required

Caller metadata returned with the Batch.

objectstring
Required

Object type.

output_file_idstring | null
Optional

RunAPI output File ID

request_countsobject
Required
request_counts.completedinteger
Required
request_counts.failedinteger
Required
request_counts.totalinteger
Required
statusstring
Required

Batch lifecycle status.

Allowed values: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled