Quickstart

This guide walks you through authenticating, submitting a moderation request, and checking the result.

Prerequisites

A Omnifence account. Sign up at the dashboard — your organization is provisioned automatically on first signup.
An API key. Create one from the API Keys page in the dashboard — the raw value is shown once at creation, so copy it immediately.
cURL or any HTTP client.

Steps

Authenticate

Include your API key as a Bearer token in the Authorization header with every request.

export OMNIFENCE_API_KEY="your_api_key_here"

Submit an image moderation request

Send an image URL for moderation. The API returns a job ID immediately. Use POST /api/v1/moderate/prompt to moderate a text prompt instead, or POST /api/v1/moderate/video for a video URL.

curl -X POST https://api.omnifence.ai/api/v1/moderate/image \
  -H "Authorization: Bearer $OMNIFENCE_API_KEY" \
  -F "image=https://example.com/photo.jpg"

Response

{
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "queued"
}

Check job status

Poll the job endpoint with the returned job_id.

curl https://api.omnifence.ai/api/v1/job/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer $OMNIFENCE_API_KEY"

Response

{
  "is_prohibited": false,
  "categories": {
    "ai_adult_general": false,
    "underage": false,
    "nsfw": false
  },
  "job_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "type": "image",
  "status": "completed",
  "created_at": "2026-05-19T12:00:00.000Z",
  "completed_at": "2026-05-19T12:00:05.000Z"
}

Set up a webhook (optional)

Instead of polling, register a webhook to receive results automatically.

curl -X POST https://api.omnifence.ai/api/v1/webhook/register \
  -H "Authorization: Bearer $OMNIFENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-app.com/webhooks/omnifence"}'

Response

{
  "message": "Webhook URL registered successfully",
  "url": "https://your-app.com/webhooks/omnifence"
}

Next steps

Authentication

Learn how API keys work and how to manage them.

Content moderation

Understand the full moderation pipeline.

Real-time progress

Stream live progress updates for long-running jobs.

Handle a rejection

Understand decision logic and what to do when a job is rejected.

Webhook reliability

Build reliable webhook handling with fallback polling.

API reference

Full endpoint reference with request and response schemas.

Getting started

Platform

Moderation

Prerequisites

Steps

Next steps

Authentication

Content moderation

Real-time progress

Handle a rejection

Webhook reliability

API reference

​Prerequisites

​Steps

​Next steps

Authentication

Content moderation

Real-time progress

Handle a rejection

Webhook reliability

API reference

Prerequisites

Steps

Next steps