{ "openapi": "3.1.0", "info": { "title": "Runware API - Content Safety", "summary": "NSFW detection for images and videos with a confidence score", "description": "Content Safety classifies images and videos as safe or not safe for work, returning a verdict and a confidence score. It exposes the same content checking used by the safety.checkContent parameter as a standalone model, so media can be screened before generation, on upload, or across an existing library. Video inputs support fast checking on key frames or full checking on every frame.", "version": "1.0.0", "x-model-id": "content-safety", "x-air-id": "content-safety", "x-status": "coming-soon", "x-capabilities": [ "image-to-text", "video-to-text", "checkpoint", "content-safety" ], "x-cover-image": "https://assets.runware.ai/covers/content-safety.jpg" }, "servers": [ { "url": "https://api.runware.ai/v1", "description": "Runware REST API" } ], "components": { "securitySchemes": { "apiKeyAuth": { "type": "http", "scheme": "bearer", "description": "Runware API Key (e.g., Bearer )" } }, "schemas": { "AuthenticationTask": { "title": "Authentication", "description": "Authenticates a connection using an API key. Can be sent as the first element of the request array as an alternative to using the Authorization header.", "type": "object", "x-response-schema": "https://schemas.runware.ai/responses/utilities/authentication.json", "properties": { "taskType": { "$id": "https://schemas.runware.ai/requests/parameters/api/task-type.json", "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "authentication" }, "apiKey": { "$id": "https://schemas.runware.ai/requests/parameters/authentication/api-key.json", "title": "API Key", "description": "Your Runware API key.", "type": "string" }, "connectionSessionUUID": { "$id": "https://schemas.runware.ai/requests/parameters/authentication/connection-session-uuid.json", "title": "Connection Session UUID", "description": "Optional session UUID to resume a previous connection and receive any buffered results.", "type": "string", "format": "uuid" } }, "required": [ "taskType", "apiKey" ], "additionalProperties": false }, "RequestBody": { "type": "array", "items": { "type": "object", "properties": { "model": { "title": "Model", "description": "Identifier of the model to use for generation.", "type": "string", "const": "runware:content-safety@1" }, "deliveryMethod": { "title": "Delivery Method", "description": "Determines how the API delivers task results.", "type": "string", "oneOf": [ { "const": "sync", "description": "Returns complete results directly in the API response." }, { "const": "async", "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse." } ], "default": "sync" }, "inputs": { "title": "Inputs", "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.", "type": "object", "properties": { "image": { "title": "Image", "description": "Image input (UUID, URL, Data URI, or Base64).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" }, { "pattern": "^data:image\\/[a-zA-Z]+;base64,[a-zA-Z0-9+/=]+$" }, { "pattern": "^[a-zA-Z0-9+/=]+$" } ] }, "video": { "title": "Video", "description": "Video input (UUID or URL).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" } ] } }, "additionalProperties": false }, "settings": { "title": "Settings", "description": "Global inference settings.", "type": "object", "properties": { "mode": { "title": "Safety Mode", "description": "Safety checking mode for video generation.", "type": "string", "oneOf": [ { "const": "fast", "title": "Fast", "description": "Checks key frames." }, { "const": "full", "title": "Full", "description": "Checks all frames." } ], "default": "fast" } }, "additionalProperties": false }, "taskType": { "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "caption" }, "taskUUID": { "title": "Task UUID", "description": "UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.", "type": "string", "format": "uuid" }, "webhookURL": { "title": "Webhook URL", "description": "Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.", "type": "string", "format": "uri" }, "includeCost": { "title": "Include Cost", "description": "Include task cost in the response.", "type": "boolean" } }, "required": [ "inputs", "taskType", "taskUUID", "model" ], "allOf": [ { "if": { "properties": { "settings": { "required": [ "mode" ] } }, "required": [ "settings" ] }, "then": { "properties": { "inputs": { "required": [ "video" ] } }, "required": [ "inputs" ] } }, { "oneOf": [ { "properties": { "inputs": { "required": [ "image" ] } }, "required": [ "inputs" ] }, { "properties": { "inputs": { "required": [ "video" ] } }, "required": [ "inputs" ] } ] } ], "additionalProperties": false }, "description": "You must always POST an array of task objects." }, "ResponseBody": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "description": "Unknown response structure" } } } }, "ErrorResponse": { "title": "Error Response", "description": "Standard error response returned by the Runware API.", "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "additionalProperties": true, "properties": { "code": { "type": "string", "description": "A short identifier for the error (e.g., invalidApiKey, timeoutProvider)." }, "message": { "type": "string", "description": "A human-readable explanation of what went wrong." }, "parameter": { "type": "string", "description": "The request parameter related to the error, if applicable." }, "taskType": { "type": "string", "description": "The task type of the request that failed." }, "taskUUID": { "type": "string", "description": "The unique identifier of the failed request." }, "documentation": { "type": "string", "description": "A link to relevant documentation." } } } } }, "required": [ "errors" ], "additionalProperties": false } } }, "paths": { "/": { "post": { "summary": "Run Content Safety", "description": "Content Safety classifies images and videos as safe or not safe for work, returning a verdict and a confidence score. It exposes the same content checking used by the safety.checkContent parameter as a standalone model, so media can be screened before generation, on upload, or across an existing library. Video inputs support fast checking on key frames or full checking on every frame.", "operationId": "run_content_safety", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBody" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseBody" } } } }, "400": { "description": "Bad Request — Missing or invalid parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized — No valid API key provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "402": { "description": "Payment Required — Insufficient account balance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden — The API key lacks permissions for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Too Many Requests — Rate limit exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server Error — Something went wrong on Runware's end.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable — Temporarily unavailable (maintenance or capacity).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "security": [ { "apiKeyAuth": [] } ] }