Skip to content
POST/api/v1/moderation/video

Moderate a video by sampled frames (BYO vision model)

Frame-sampled vision moderation: each caller-supplied frame is moderated with the project's BYO vision vendor (OpenAI omni-moderation) and aggregated to a clip verdict. Provide frames[] (imageUrl or imageBase64 each) plus optional threshold/maxFrames/sampleEveryN. Returns flagged, score, categories, firstFlaggedFrame and per-frame results. Editor role; org+project scoped.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "orgId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "frames": [
    {
      "imageUrl": "https://example.com",
      "imageBase64": "string",
      "mimeType": "string",
      "timestampMs": 0
    }
  ],
  "threshold": 0,
  "maxFrames": 1,
  "sampleEveryN": 1,
  "provider": "openai"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "orgId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "projectId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "frames": {
          "minItems": 1,
          "maxItems": 256,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "imageUrl": {
                "type": "string",
                "maxLength": 8192,
                "format": "uri"
              },
              "imageBase64": {
                "type": "string",
                "maxLength": 8000000
              },
              "mimeType": {
                "type": "string",
                "maxLength": 128
              },
              "timestampMs": {
                "type": "number",
                "minimum": 0
              }
            },
            "additionalProperties": false
          }
        },
        "threshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "maxFrames": {
          "type": "integer",
          "minimum": 1,
          "maximum": 256
        },
        "sampleEveryN": {
          "type": "integer",
          "minimum": 1,
          "maximum": 256
        },
        "provider": {
          "type": "string",
          "enum": [
            "openai"
          ]
        }
      },
      "required": [
        "orgId",
        "projectId",
        "frames"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Aggregated clip verdict.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/moderation/video \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "orgId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "frames": [ { "imageUrl": "https://example.com", "imageBase64": "string", "mimeType": "string", "timestampMs": 0 } ], "threshold": 0, "maxFrames": 1, "sampleEveryN": 1, "provider": "openai" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/moderation/video",
  body: {
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "frames": [
      {
        "imageUrl": "https://example.com",
        "imageBase64": "string",
        "mimeType": "string",
        "timestampMs": 0
      }
    ],
    "threshold": 0,
    "maxFrames": 1,
    "sampleEveryN": 1,
    "provider": "openai"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/moderation/video",
    body={
    "orgId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "frames": [
        {
            "imageUrl": "https://example.com",
            "imageBase64": "string",
            "mimeType": "string",
            "timestampMs": 0
        }
    ],
    "threshold": 0,
    "maxFrames": 1,
    "sampleEveryN": 1,
    "provider": "openai"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"orgId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","frames":[{"imageUrl":"https://example.com","imageBase64":"string","mimeType":"string","timestampMs":0}],"threshold":0,"maxFrames":1,"sampleEveryN":1,"provider":"openai"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/moderation/video", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Moderation endpoints