Name: Video NSFW Filter API: Check Videos for NSFW Content
Brand: magicapi
SKU: api-magicapi-video-nsfw-content-filter-littletry-video-nsfw-filter
Availability: InStock
Author: API Market

Shashank Agarwal

# 🛡️ Video NSFW Filter API (littletry Video NSFW Filter)

## Overview
Video NSFW Filter checks a video for visual NSFW content. It samples frames evenly across the video, checks each one and writes the result to a JSON report, with optional JPEG screenshots of the sampled frames.

Send a video URL. Each request returns a list of file URLs: the JSON report plus the screenshots selected by `return_frames`.

## Features
- **Frame sampling**: `num_frames` (default 8) frames spread evenly across the video; short videos are deduplicated.
- **Adjustable strictness**: `threshold_offset` (0 to 0.1, default 0.02) is an extra similarity margin; higher values are less strict.
- **Special-care mode**: `strict_special_care` (default `true`) keeps the stricter matching when special-care concepts match.
- **Screenshots**: `return_frames` `none` (default), `flagged` (NSFW-matched samples only) or `all`.
- **JSON report**: an overall `nsfw_detected` verdict, `checked_frames` and `flagged_frame_count`, plus one entry per sampled frame with its `frame_number`, `timestamp_seconds`, verdict, matched `nsfw` and `special` concepts and screenshot file name.
- **Details**: `include_details` adds diagnostic scores, detector settings and video metadata to the report.

## Use Cases
1. **Upload moderation**: check user videos before they are published.
2. **Generated video checks**: screen clips from video models before showing them.
3. **Review queues**: send flagged videos, with the flagged screenshots, to human moderators.

## Visual Examples
### Example Input
The example samples 8 frames from a video and asks for all sampled frames as screenshots.

```json
{
  "video": "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-input-api-market.mp4",
  "num_frames": 8,
  "return_frames": "all",
  "include_details": false,
  "threshold_offset": 0.02,
  "strict_special_care": true
}
```

### Example Output
The request returned a JSON report and the 8 sampled frames. The report found no NSFW content (shortened to the first two of its 8 frame entries):

```json
{
  "nsfw_detected": false,
  "scope": "sampled_frames",
  "sampling_complete": true,
  "checked_frames": 8,
  "timestamp_source": "frame_index_div_fps_estimate",
  "output_layout": "named-files-v1",
  "report_schema_version": 5,
  "flagged_frame_count": 0,
  "frames": [
    {
      "frame_number": 1,
      "timestamp_seconds": 0.0,
      "nsfw_detected": false,
      "nsfw": [],
      "special": [],
      "image_filename": "video-nsfw-frame_00000001_5nheeb6p.jpg"
    },
    {
      "frame_number": 18,
      "timestamp_seconds": 0.708,
      "nsfw_detected": false,
      "nsfw": [],
      "special": [],
      "image_filename": "video-nsfw-frame_00000018_j2xtrnxv.jpg"
    }
  ]
}
```

The sampled frames, in the order they appear in `output`:

![Video NSFW Filter sampled frame 1](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-1-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 2](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-2-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 3](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-3-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 4](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-4-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 5](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-5-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 6](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-6-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 7](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-7-bbny85sj-api-market.jpg)
![Video NSFW Filter sampled frame 8](https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-8-bbny85sj-api-market.jpg)

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `video` | string (URL) | Yes | none |  | Video URL to check for visual NSFW content. |
| `num_frames` | integer | No | `8` | 1 or more | Number of frames sampled evenly across the video. With 2 or more samples both ends are included; one sample selects the middle. Short videos are deduplicated. |
| `threshold_offset` | number | No | `0.02` | 0 to 0.1 | Additional NSFW similarity margin. Higher values are less strict; this is not a probability threshold. |
| `strict_special_care` | boolean | No | `true` |  | Keep the original stricter normal-concept matching when special-care concepts match. |
| `return_frames` | string | No | `none` | `none`, `flagged`, `all` | Return no screenshots, only NSFW-matched samples, or all sampled frames as JPEG files. |
| `include_details` | boolean | No | `false` |  | Add diagnostic scores, detector settings and video metadata to the report. The default report is compact. |

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.001 per API unit.
- **1 API unit = 1 successful request** that uses up to 4 seconds of processing time. A request that needs more processing time is billed one more unit for each started block of 4 seconds (for example, 5 to 8 seconds of processing is 2 units, $0.002).
- **Example cost**: the example request on this page used 1.1 seconds of processing, so it was billed 1 unit ($0.001).
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** are free and don't count toward API unit usage.
- **No monthly subscription fee.**

## API Documentation

### Base URL
All API requests go to: `https://prod.api.market/api/v1/magicapi/video-nsfw-content-filter-littletry-video-nsfw-filter`

### Authentication
Send your api.market API key in the `x-api-market-key` header:
```
x-api-market-key: YOUR_API_MARKET_KEY
```

### Asynchronous Processing
**IMPORTANT**: This API is asynchronous. The flow is:
1. Send a POST request to `/predictions`. A successful request returns **201 Created** with a prediction `id` and a `status` of `starting` or `processing`.
2. Poll GET `/predictions/{id}` with that ID.
3. Keep polling while `status` is `starting` or `processing`.
4. Stop when `status` is `succeeded` (read `output`), `failed` or `canceled` (read `error`).

A polling interval of 1 second and an overall timeout of 600 seconds (10 minutes) work well.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/video-nsfw-content-filter-littletry-video-nsfw-filter/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "42e30b887c047617180fc22b3e7a03a0666e7cc639f22e60bac4be4ec66448ca",
    "input": {
      "video": "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-input-api-market.mp4",
      "num_frames": 8,
      "return_frames": "all",
      "include_details": false,
      "threshold_offset": 0.02,
      "strict_special_care": true
    }
  }'
```

Response (201 Created):
```json
{
  "id": "bbny85sja1rga0d1d208cbj6m4",
  "version": "42e30b887c047617180fc22b3e7a03a0666e7cc639f22e60bac4be4ec66448ca",
  "status": "starting",
  "created_at": "2026-10-23T11:23:14.568Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/video-nsfw-content-filter-littletry-video-nsfw-filter/predictions/{id}" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "bbny85sja1rga0d1d208cbj6m4",
  "status": "succeeded",
  "output": [
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-1-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-2-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-3-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-4-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-5-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-6-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-7-bbny85sj-api-market.jpg",
    "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-output-8-bbny85sj-api-market.jpg"
  ],
  "error": null,
  "created_at": "2026-10-23T11:23:14.568Z",
  "started_at": "2026-10-23T11:23:14.587Z",
  "completed_at": "2026-10-23T11:23:15.704Z"
}
```

`output` is a list of file URLs. It always contains one JSON report file (named like `video-nsfw-report_<id>.json`) with the result, plus the JPEG screenshots selected by `return_frames`. The position of the report in the list is not fixed, so find it by its `.json` extension. The report holds the overall `nsfw_detected` verdict, `checked_frames`, `flagged_frame_count` and a `frames` list with the result for each sampled frame; each entry's `image_filename` matches a screenshot file name. The example response above lists the 8 screenshots; the report URL from that run is left out.

### Status Codes
- **201 Created**: prediction created (POST `/predictions`). This is the normal success response.
- **200 OK**: prediction details returned (GET `/predictions/{id}`).
- **400 Bad Request**: invalid input, for example a missing `video`, a `threshold_offset` above 0.1, or a `return_frames` value that is not in the list.
- **401 Unauthorized**: missing or invalid API key.
- **404 Not Found**: no prediction with that ID.
- **429 Too Many Requests**: rate limit exceeded.
- **500 Internal Server Error** or **503 Service Unavailable**: temporary server problem; retry later.

## Rate Limits
All plans allow 10 requests per second. Requests above that return `429 Too Many Requests`; back off before retrying and honour any `Retry-After` header. Polling a prediction with GET is free but still counts toward the per-second limit, so poll every 1 to 5 seconds rather than in a tight loop.

## Error Handling
- Check the HTTP status code of every request and read the response body for the error message.
- A prediction can also end with `status` set to `failed`; the `error` field then explains why. Failed predictions are not billed.
- Retry 429, 500 and 503 responses with exponential backoff. Fix the input before retrying a 400.

## Implementation Guide
### Example Code

#### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/video-nsfw-content-filter-littletry-video-nsfw-filter";

async function createAndWaitForPrediction(input) {
  const response = await fetch(`${baseUrl}/predictions`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-market-key": apiKey
    },
    body: JSON.stringify({ version: "42e30b887c047617180fc22b3e7a03a0666e7cc639f22e60bac4be4ec66448ca", input })
  });

  if (response.status !== 201) {
    throw new Error(`API error: ${response.status} ${await response.text()}`);
  }

  const prediction = await response.json();
  return pollForResults(prediction.id);
}

const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function pollForResults(predictionId) {
  const maxTimeout = 600000;
  const pollInterval = 1000;
  const startTime = Date.now();

  while (Date.now() - startTime < maxTimeout) {
    const response = await fetch(`${baseUrl}/predictions/${predictionId}`, {
      headers: { "x-api-market-key": apiKey }
    });

    if (!response.ok) {
      throw new Error(`API error: ${response.status} ${await response.text()}`);
    }

    const prediction = await response.json();

    if (prediction.status === "succeeded") {
      return prediction.output;
    }

    if (prediction.status === "failed" || prediction.status === "canceled") {
      throw new Error(`Prediction ${prediction.status}: ${prediction.error || "Unknown error"}`);
    }

    await delay(pollInterval);
  }

  throw new Error("Prediction timed out after 10 minutes");
}

createAndWaitForPrediction({
    "video": "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-input-api-market.mp4",
    "num_frames": 8,
    "return_frames": "all",
    "include_details": false,
    "threshold_offset": 0.02,
    "strict_special_care": true
  }).then((output) => console.log(output));
```

#### Python
```python
import time
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/video-nsfw-content-filter-littletry-video-nsfw-filter"


def create_and_wait_for_prediction(input_data):
    headers = {"Content-Type": "application/json", "x-api-market-key": API_KEY}
    response = requests.post(
        f"{BASE_URL}/predictions",
        headers=headers,
        json={"version": "42e30b887c047617180fc22b3e7a03a0666e7cc639f22e60bac4be4ec66448ca", "input": input_data},
    )

    if response.status_code != 201:
        raise Exception(f"API error: {response.status_code} {response.text}")

    return poll_for_results(response.json()["id"])


def poll_for_results(prediction_id):
    max_timeout = 600
    poll_interval = 1
    headers = {"x-api-market-key": API_KEY}
    start_time = time.time()

    while time.time() - start_time < max_timeout:
        response = requests.get(f"{BASE_URL}/predictions/{prediction_id}", headers=headers)

        if response.status_code != 200:
            raise Exception(f"API error: {response.status_code} {response.text}")

        prediction = response.json()

        if prediction["status"] == "succeeded":
            return prediction["output"]

        if prediction["status"] in ("failed", "canceled"):
            raise Exception(f"Prediction {prediction['status']}: {prediction.get('error') or 'Unknown error'}")

        time.sleep(poll_interval)

    raise Exception("Prediction timed out after 10 minutes")


print(create_and_wait_for_prediction({
    "video": "https://blog.api.market/wp-content/uploads/2026/10/video-nsfw-filter-input-api-market.mp4",
    "num_frames": 8,
    "return_frames": "all",
    "include_details": False,
    "threshold_offset": 0.02,
    "strict_special_care": True
}))
```

## FAQ
- **Where is the verdict?**
  - In the JSON report file in `output`. Download the URL that ends in `.json` and read `nsfw_detected` (overall) and `flagged_frame_count`; each entry in `frames` gives the result for one sampled frame.
- **How do I get screenshots of flagged frames only?**
  - Set `return_frames` to `flagged`. Use `all` for every sampled frame or `none` (the default) for the report only.
- **How do I check more of the video?**
  - Raise `num_frames`. More samples take longer, and one unit covers up to 4 seconds of processing.
- **Is the 201 response from POST an error?**
  - No. 201 Created means the prediction was accepted. Use the returned `id` to poll GET `/predictions/{id}` until `status` is `succeeded`, `failed` or `canceled`.
- **What if my prediction fails?**
  - Failed predictions are not billed. Read the `error` field, adjust the input and try again.

## Contact Us
If you have any questions, reach out to us through the chat on the bottom right of the page. You can also email our support team at hello@magicapi.com.


Check videos for NSFW content across sampled frames, with adjustable strictness, a JSON report and optional screenshots. $0.001 per API unit, pay as you go.