Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omnifence.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Base URL

https://api.evershield.ai
Moderation and platform endpoints are under /api/v1. The health check is at the root (/health).

​
Authentication

All endpoints except /health require a Bearer token in the Authorization header. See authentication for details. 
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 SSE progress streams which return text/event-stream)

​
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

​
Client endpoints

MethodPathDescription
GET/healthHealth check
POST/api/v1/moderate/promptSubmit prompt moderation
POST/api/v1/moderate/imageSubmit image moderation
POST/api/v1/moderate/videoSubmit video moderation
GET/api/v1/job/{id}Get job status
GET/api/v1/job/{id}/progressStream job progress
GET/api/v1/usageGet usage summary
POST/api/v1/webhook/registerRegister webhook

​
Admin endpoints

Requires the admin:config scope. See authentication.
MethodPathDescription
GET/api/v1/admin/keywordsList keywords
POST/api/v1/admin/keywordsCreate keyword
DELETE/api/v1/admin/keywords/{id}Delete keyword
GET/api/v1/admin/promptsList prompts
GET/api/v1/admin/prompts/{slug}Get prompt
PUT/api/v1/admin/prompts/{slug}Update prompt
POST/api/v1/admin/prompts/testTest prompt
GET/api/v1/admin/models/{provider}List models
DELETE/api/v1/admin/models/{provider}/cacheInvalidate models cache
GET/api/v1/admin/clientsList clients
GET/api/v1/admin/clients/{id}Get client
PUT/api/v1/admin/clients/{id}Update client
POST/api/v1/admin/clients/{id}/banBan client
POST/api/v1/admin/clients/{id}/unbanUnban client
POST/api/v1/admin/clients/{id}/keys/{hash}/revokeRevoke API key
POST/api/v1/admin/clients/{id}/keys/{hash}/activateActivate API key
GET/api/v1/admin/statsGet stats
GET/api/v1/admin/jobsList jobs
GET/api/v1/admin/queuesGet queues