---
updatedAt: 2026-04-23T14:31:17.000Z
agentTools:
  projectIndex: https://docs.bynn.com/llms.txt
---

# Get a single moderation model with full documentation

Get detailed information about a specific moderation model including full documentation

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "BYNN API",
    "description": "The BYNN API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects. To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no “switch” for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test-mode credentials never hit live networks and incur no cost. **AUTHENTICATION:** Please use your **Private API Key** that looks like this `private_Nv7UpwQbSmWtUTiSWfw1bdHm` as the username and password in HTTP basic auth.",
    "termsOfService": "https://bynn.com/terms",
    "contact": {
      "name": "BYNN Development Team",
      "email": "hello@bynn.com",
      "url": "https://docs.bynn.com"
    },
    "license": {
      "name": "BYNN Documentation",
      "url": "https://docs.bynn.com"
    },
    "version": "1.0"
  },
  "tags": [
    {
      "name": "moderation",
      "description": "Operations about moderations"
    }
  ],
  "paths": {
    "/moderation/models/{api_name}": {
      "get": {
        "summary": "Get a single moderation model with full documentation",
        "description": "Get detailed information about a specific moderation model including full documentation",
        "parameters": [
          {
            "in": "path",
            "name": "api_name",
            "description": "Model API name (e.g., nudity-detection)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Get a single moderation model with full documentation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Bynn_V1_Entities_ModerationModelEntity"
                }
              }
            }
          }
        },
        "tags": [
          "moderation"
        ],
        "operationId": "getModerationModelsApiName"
      }
    }
  },
  "servers": [
    {
      "url": "//api.bynn.com/v1"
    }
  ],
  "components": {
    "schemas": {
      "Bynn_V1_Entities_ModerationModelEntity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "nudity_detection",
            "description": "Unique model identifier"
          },
          "api_name": {
            "type": "string",
            "example": "nudity-detection",
            "description": "API name for model (hyphenated, used in API calls)"
          },
          "name": {
            "type": "string",
            "example": "Nudity & Adult Content Detection",
            "description": "Model display name"
          },
          "description": {
            "type": "string",
            "example": "Detect nudity across 29 classes from very explicit to mildly suggestive",
            "description": "Model description"
          },
          "category": {
            "type": "string",
            "example": "Standard Moderation",
            "description": "Model category"
          },
          "moderation_type": {
            "type": "string",
            "enum": [
              "image",
              "video",
              "audio",
              "text"
            ],
            "example": "image",
            "description": "Type of moderation (image, video, audio, text)"
          },
          "icon": {
            "type": "string",
            "example": "shield-alert",
            "description": "Lucide icon name for the model"
          },
          "is_active": {
            "type": "boolean",
            "example": true,
            "description": "Whether the model is currently active"
          },
          "accuracy": {
            "type": "number",
            "example": 96.5,
            "description": "Model accuracy percentage"
          },
          "avg_response_time_ms": {
            "type": "integer",
            "format": "int32",
            "example": 150,
            "description": "Average response time in milliseconds (calculated from last 10 completed inferences)"
          },
          "pricing": {
            "type": "object",
            "description": "Pricing information"
          },
          "all_plans_pricing": {
            "type": "object",
            "description": "Pricing information for all plan tiers (Trial, Core, Compliance, Forensic, Enterprise, Custom, Crypto)"
          },
          "supported_formats": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {}
            },
            "example": [
              "jpg",
              "png",
              "gif",
              "webp"
            ],
            "description": "Supported file formats"
          },
          "max_file_size_mb": {
            "type": "integer",
            "format": "int32",
            "example": 10,
            "description": "Maximum file size in MB"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {}
            },
            "example": [
              "nsfw",
              "adult-content",
              "safety"
            ],
            "description": "Model tags for filtering"
          },
          "input_schema": {
            "type": "object",
            "description": "Input parameter schema from Triton model class"
          },
          "output_schema": {
            "type": "object",
            "description": "Output field schema from Triton model class"
          },
          "example_request": {
            "type": "object",
            "description": "Example API request parameters"
          },
          "example_response": {
            "type": "object",
            "description": "Example API response"
          },
          "require_plan": {
            "type": "string",
            "enum": [
              "trial",
              "core",
              "compliance",
              "forensic",
              "enterprise",
              "custom",
              "crypto"
            ],
            "example": "core",
            "description": "Minimum plan required to access this model"
          },
          "sample_content": {
            "type": "array",
            "example": [
              {
                "url": "https://example.com/sample.jpg",
                "label": "Sample image"
              }
            ],
            "description": "Sample content for testing (URLs for media, text for text models)",
            "items": {}
          },
          "version": {
            "type": "integer",
            "format": "int32",
            "example": 2601,
            "description": "Model version number"
          },
          "version_date": {
            "type": "string",
            "example": "2026-01-03",
            "description": "Model version release date"
          },
          "documentation_image_url": {
            "type": "string",
            "example": "https://cdn.example.com/model-docs/nudity-detection.webp",
            "description": "Main documentation image URL"
          },
          "has_documentation": {
            "type": "boolean",
            "example": true,
            "description": "Whether the model has documentation content"
          },
          "documentation": {
            "type": "string",
            "description": "Rich text HTML documentation for the model"
          }
        },
        "required": [
          "id",
          "api_name",
          "name",
          "description",
          "category",
          "moderation_type",
          "icon",
          "is_active",
          "accuracy",
          "avg_response_time_ms",
          "pricing",
          "supported_formats",
          "max_file_size_mb",
          "tags",
          "input_schema",
          "output_schema",
          "example_request",
          "example_response",
          "require_plan",
          "sample_content",
          "version",
          "version_date",
          "documentation_image_url",
          "has_documentation"
        ],
        "description": "Bynn_V1_Entities_ModerationModelEntity model"
      }
    }
  }
}
```