DashboardGet started

API reference

Complete reference for Omnifence API endpoints

Base URL#

Code
https://api.omnifence.ai

Moderation, platform and Shared Registry endpoints are under /api/v1.

Authentication#

All endpoints require a Bearer token in the Authorization header. See authentication for details.

Shell
Authorization: Bearer YOUR_API_KEY

Content types#

  • Moderation submissions: multipart/form-data (prompt text and image/video URLs sent as form fields)
  • Other requests: application/json
  • All responses: application/json (except job exports, which stream text/csv; charset=utf-8)

Versioning#

The API is versioned via URL path. The current version is v1. All moderation, job, usage, and webhook endpoints are prefixed with /api/v1/.

Endpoints#

Moderation#

Method Path Description
POST /api/v1/moderate/text Submit text moderation
POST /api/v1/moderate/image Submit image moderation
POST /api/v1/moderate/video Submit video moderation
POST /api/v1/moderate/audio Submit audio moderation

Jobs#

Method Path Description
GET /api/v1/jobs List jobs
GET /api/v1/job/{id} Get job status
GET /api/v1/jobs/export Export jobs as CSV

Account#

Method Path Description
GET /api/v1/me/moderation-config Get moderation config
PUT /api/v1/me/moderation-config Update moderation config
GET /api/v1/me/custom-categories List custom categories
POST /api/v1/me/custom-categories Create a custom category
POST /api/v1/me/custom-categories/generate-prompt Draft a custom-category system prompt
PUT /api/v1/me/custom-categories/{id} Update a custom category
DELETE /api/v1/me/custom-categories/{id} Delete a custom category
GET /api/v1/me/terms Get terms status
GET /api/v1/me/terms/documents/{id}/file Download a legal document
POST /api/v1/me/terms/accept Accept terms

Shared Registry#

Needs a registry key. See Shared Registry membership.

Method Path Description
POST /api/v1/registry/check Check identifiers
POST /api/v1/registry/entries Report a banned user
GET /api/v1/registry/entries List your reports
POST /api/v1/registry/entries/{id}/revoke Revoke a report

Webhooks#

Method Path Description
POST /api/v1/webhook/register Register webhook
DELETE /api/v1/webhook/register Unregister webhook