Omni API Documentation

Introduction

The Omni API provides a powerful, flexible interface for content moderation. It allows you to moderate both text and images with a single API call, providing comprehensive protection for your platform.

Authentication

All API requests require authentication using an API key. You can obtain an API key from your Omni dashboard.

Include your API key in the request headers:

X-API-Key: your_api_key_here

Quick Start

Here's a simple example of how to moderate text content:

curl -X POST https://api.omnimoderate.com/v1/moderate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "input": [
      { "type": "text", "text": "This is a sample text to moderate." }
    ]
  }'

And here's how to moderate both text and images:

curl -X POST https://api.omnimoderate.com/v1/moderate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "input": [
      { "type": "text", "text": "Check out this amazing photo!" },
      { "type": "image", "base64": "data:image/jpeg;base64,/9j/4AAQSkZ..." }
    ],
    "analyze_images": true
  }'

Key Features

Comprehensive Content Moderation

The API evaluates content across multiple categories of harmful content, including hate speech, harassment, self-harm, sexual content, and violence.

Dual-Layer Text Evaluation

When multiple text items are submitted, the API evaluates each item individually and also evaluates all text items together. This helps catch issues that might only be apparent when text fragments are considered as a whole.

Advanced Image Analysis

In addition to standard moderation, the API can perform deep analysis of images using OpenAI's vision models. This helps detect inappropriate content that might not be caught by standard moderation techniques.

Response Verification

All API responses include a cryptographic signature that allows you to verify the response came from our service and hasn't been tampered with.

Rate Limits

The API enforces rate limits based on your subscription tier. Current rate limits are:

When rate limits are exceeded, the API returns a 429 Too Many Requests response. The response headers include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset to help you manage your API usage.

Content Size Limits

The API enforces the following size limits:

• Maximum text length: 10,000 characters per text item
• Maximum image size: 5MB per image
• Maximum items per request: 10 items (text and images combined)

Next Steps

Explore the documentation to learn more about the API endpoints, request and response formats, and integration examples.

• Moderate Content Endpoint
• Text Moderation Examples
• Image Moderation Examples
• JavaScript SDK