{ "openapi": "3.1.0", "info": { "title": "Runware API - klingai-video-o3-pro", "version": "1.0.0", "description": "Kling VIDEO O3 Pro is a unified multimodal video model that generates HD clips from text or images with native audio output. It prioritizes detail, motion realism, and stable subject identity, and it supports reference-driven generation plus prompt-based video editing with strong temporal consistency." }, "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": { "const": "authentication", "title": "Task Type", "description": "The type of task to perform." }, "apiKey": { "title": "API Key", "description": "Your Runware API key.", "type": "string" }, "connectionSessionUUID": { "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": "klingai:kling-video@o3-pro" }, "inputs": { "title": "Inputs", "description": "The unified payload wrapper for complex media assets dictating image, video or audio inference constraints.", "type": "object", "properties": { "referenceImages": { "title": "Reference Images", "description": "List of reference images (UUID, URL, Data URI, or Base64).", "type": "array", "minItems": 1, "items": { "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+/=]+$" } ] }, "maxItems": 7 }, "frameImages": { "title": "Frame Images", "description": "An array of objects that define key frames to guide video generation. Each object specifies an input image and optionally its position within the video timeline.\n\nThe `frameImages` parameter allows you to constrain specific frames within the video sequence, ensuring that particular visual content appears at designated points. This is different from `referenceImages`, which provide overall visual guidance without constraining specific timeline positions.\n\nWhen the `frame` parameter is omitted from objects, automatic distribution rules apply:\n\n- **1 image**: Used as the first frame.\n- **2 images**: First and last frames.\n- **3+ images**: First and last frames, with intermediate images evenly spaced between.\n\n**Examples**:\n\n**Single frame (automatic positioning):** When only one image is provided, it automatically becomes the first frame of the video.\n\n```json\n\"frameImages\": [\n {\n \"image\": \"aac49721-1964-481a-ae78-8a4e29b91402\"\n }\n]\n```\n\n**First and last frames:** With two images, they automatically become the first and last frames of the video sequence.\n\n```json\n\"frameImages\": [\n {\n \"image\": \"aac49721-1964-481a-ae78-8a4e29b91402\",\n \"frame\": \"first\"\n },\n {\n \"image\": \"3ad204c3-a9de-4963-8a1a-c3911e3afafe\",\n \"frame\": \"last\"\n }\n]\n```\n\n**Multiple frames:** With three or more images, the first and last are anchored while intermediate frames are evenly distributed across the timeline.\n\n```json\n\"frameImages\": [\n {\n \"image\": \"aac49721-1964-481a-ae78-8a4e29b91402\",\n \"frame\": \"first\"\n },\n {\n \"image\": \"c00abf5f-6cdb-4642-a01d-1bfff7bc3cf7\"\n },\n {\n \"image\": \"3ad204c3-a9de-4963-8a1a-c3911e3afafe\",\n \"frame\": \"last\"\n }\n]\n```\n\n[Read full documentation](https://runware.ai/docs/models/klingai-video-o3-pro#frameImages)", "type": "array", "minItems": 1, "items": { "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+/=]+$" } ] }, "frame": { "title": "Frame", "description": "Target frame position for the image. Supports first and last frame.", "oneOf": [ { "const": "first", "description": "First frame of the video." }, { "const": "last", "description": "Last frame of the video." }, { "const": 0, "description": "Frame index 0 (first frame)." }, { "const": -1, "description": "Frame index -1 (last frame)." } ] } }, "required": [ "image" ], "additionalProperties": false }, "maxItems": 2 }, "video": { "title": "Video", "description": "Source video for prompt-based editing. Dimensions and duration match the input video (UUID or URL).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" } ] }, "referenceVideos": { "title": "Reference Videos", "description": "List of reference videos (UUID, URL).", "type": "array", "minItems": 1, "items": { "title": "Video", "description": "Video input (UUID or URL).", "type": "string", "anyOf": [ { "format": "uuid" }, { "format": "uri" } ] }, "maxItems": 1 }, "elements": { "title": "Elements", "description": "Elements allow you to include reusable assets (images, videos, or voices) in your video generation. Each element is identified by an `id` and can be referenced in the prompt using `<<>>`, `<<>>`, etc. in order of appearance.\n\nAn element can contain:\n\n- **Images** via `frontalImage` and optionally `images` (up to 3 additional angles).\n- **Videos** via `videos` (cannot be combined with images).\n- **Voices** via `voices` (can only be combined with images, not videos).\n\n**Examples**:\n\n**Create a new element with an image:**\n\n```json\n\"positivePrompt\": \"A video of <<>> walking through a futuristic city\",\n\"inputs\": {\n \"elements\": [\n {\n \"id\": \"my-character-id\",\n \"description\": \"A young woman with red hair\",\n \"frontalImage\": \"c64351d5-4c59-42f7-95e1-eace013eddab\",\n \"tags\": [\"Character\"]\n }\n ]\n}\n```\n\n**Reuse a previously created element by ID:**\n\n```json\n\"positivePrompt\": \"A video of <<>> sitting in a coffee shop, reading a book\",\n\"inputs\": {\n \"elements\": [\n {\n \"id\": \"my-character-id\"\n }\n ]\n}\n```\n\n[Read full documentation](https://runware.ai/docs/models/klingai-video-o3-pro#elements)", "type": "array", "minItems": 1, "maxItems": 3, "items": { "type": "object", "properties": { "id": { "type": "string", "title": "ID", "description": "Unique identifier for this element. Use to create a new element or reference a previously created one." }, "description": { "type": "string", "title": "Description", "description": "Description of the element." }, "frontalImage": { "type": "string", "title": "Frontal Image", "description": "Frontal reference image for the element. Required when using image-based elements." }, "images": { "type": "array", "title": "Images", "description": "Reference images for the element. Up to 3 images. Requires frontalImage.", "items": { "type": "string" }, "minItems": 1, "maxItems": 3 }, "videos": { "type": "array", "title": "Videos", "description": "Reference video for the element. Cannot be combined with images or voices.", "items": { "type": "string" }, "minItems": 1, "maxItems": 1 }, "voices": { "type": "array", "title": "Voices", "description": "Voice audio for the element. Can only be combined with images, not videos.", "items": { "type": "string" }, "minItems": 1, "maxItems": 1 }, "tags": { "type": "array", "title": "Tags", "description": "Classification tags for the element.", "items": { "type": "string", "enum": [ "Animal", "Character", "Hottest", "Item", "Costume", "Scene", "Effect", "Others" ] }, "minItems": 1 } }, "required": [ "id" ], "not": { "required": [ "frontalImage", "videos" ] }, "dependencies": { "images": [ "frontalImage" ], "voices": [ "frontalImage" ] }, "additionalProperties": false } } }, "additionalProperties": false }, "positivePrompt": { "title": "Positive Prompt", "description": "Text prompt describing elements to include in the generated output.", "type": "string", "minLength": 2, "maxLength": 2500 }, "width": { "title": "Width", "description": "Width of the generated media in pixels.", "type": "integer" }, "height": { "title": "Height", "description": "Height of the generated media in pixels.", "type": "integer" }, "duration": { "definitions": { "video": { "$id": "https://schemas.runware.ai/parameters/generation/duration.json?def=video", "title": "Duration", "description": "Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).", "type": "number" }, "audio": { "$id": "https://schemas.runware.ai/parameters/generation/duration.json?def=audio", "title": "Duration", "description": "Length of the generated audio track in seconds.", "type": "number" } }, "type": "integer", "default": 5, "minimum": 3, "maximum": 15, "multipleOf": 1 }, "providerSettings": { "title": "Provider Settings", "description": "Provider-specific configuration settings.", "type": "object", "properties": { "klingai": { "title": "Kling AI Settings", "description": "Provider-specific settings for Kling AI.", "type": "object", "properties": { "characterOrientation": { "title": "Character Orientation", "description": "Source for character orientation reference.", "type": "string", "oneOf": [ { "const": "image", "description": "Match orientation from the reference image." }, { "const": "video", "description": "Match orientation from the reference video." } ] }, "keepOriginalSound": { "title": "Keep Original Sound", "description": "Maintain the original sound from the reference video.", "type": "boolean", "default": false }, "multiPrompt": { "title": "Multi Prompt", "description": "Sequential prompt segments for multi-shot generation. The sum of all segment durations must equal the root-level duration.", "type": "array", "maxItems": 6, "items": { "type": "object", "properties": { "prompt": { "title": "Prompt", "description": "Text prompt describing the content for this segment.", "type": "string", "minLength": 2, "maxLength": 2500 }, "duration": { "title": "Duration", "description": "Duration in seconds for this segment.", "type": "integer", "minimum": 1 } }, "required": [ "prompt", "duration" ], "additionalProperties": false } }, "sound": { "title": "Sound", "description": "Enable native audio generation.", "type": "boolean", "default": false } }, "additionalProperties": false } }, "additionalProperties": false }, "taskType": { "title": "Task Type", "description": "Identifier for the type of task being performed", "type": "string", "const": "videoInference" }, "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", "default": false }, "numberResults": { "title": "Number of Results", "description": "Number of results to generate. Each result uses a different seed, producing variations of the same parameters.", "type": "integer", "minimum": 1, "maximum": 20, "default": 1 }, "uploadEndpoint": { "title": "Upload Endpoint", "description": "Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.\n\n**Common use cases:**\n\n- **Cloud storage**: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.\n- **CDN integration**: Upload to content delivery networks for immediate distribution.\n\n```text\n// S3 presigned URL for secure upload\nhttps://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600\n\n// Google Cloud Storage presigned URL\nhttps://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789\n\n// Custom storage endpoint\nhttps://storage.example.com/uploads/generated-image.jpg\n```\n\nThe content data will be sent as the request body to the specified URL when generation is complete.\n\n[Read full documentation](https://runware.ai/docs/models/klingai-video-o3-pro#uploadEndpoint)", "type": "string", "format": "uri" }, "ttl": { "title": "TTL", "description": "Time-to-live (TTL) in seconds for generated content. Only applies when `outputType` is `URL`.", "type": "integer", "minimum": 60 }, "outputType": { "title": "Output Type", "description": "Video output type.", "type": "string", "enum": [ "URL" ], "default": "URL" }, "outputFormat": { "title": "Output Format", "description": "Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.\n\n- \\`JPG\\`: Best for photorealistic images with smaller file sizes (no transparency).\n- \\`PNG\\`: Lossless compression, supports high quality and transparency (alpha channel).\n- \\`WEBP\\`: Modern format providing superior compression and transparency support.\n- \\`MP4\\`: Widely supported video container (H.264), recommended for general use.\n- \\`WEBM\\`: Optimized for web delivery.\n- \\`MOV\\`: QuickTime format, common in professional workflows (Apple ecosystem).\n- \\`GIF\\`: Animated image format (no audio), suitable for short loops or previews.\n- \\`MP3\\`: Compressed audio, smaller file size.\n- \\`WAV\\`: Uncompressed, high-quality audio.\n- \\`FLAC\\`: Lossless compression.\n- \\`SVG\\`: Scalable Vector Graphics.\n- \\`TIFF\\`: High-quality output supporting layers.\n\n> [!NOTE]\n> \\*\\*Transparency\\*\\*: If you are using features like background removal or LayerDiffuse that require transparency, you must select a format that supports an alpha channel (e.g., \\`PNG\\`, \\`WEBP\\`, \\`TIFF\\`). \\`JPG\\` does not support transparency.\n\n[Read full documentation](https://runware.ai/docs/models/klingai-video-o3-pro#outputFormat)", "type": "string", "enum": [ "MP4", "WEBM", "MOV" ], "default": "MP4" }, "outputQuality": { "title": "Output Quality", "description": "Compression quality of the output. Higher values preserve quality but increase file size.", "type": "integer", "minimum": 20, "maximum": 99, "default": 95 }, "deliveryMethod": { "title": "Delivery Method", "description": "Determines how the API delivers task results.", "type": "string", "oneOf": [ { "const": "async", "description": "Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation." } ], "default": "async" }, "safety": { "type": "object", "title": "Safety Settings", "description": "Content safety checking configuration for video generation.", "properties": { "checkContent": { "title": "Check Content", "description": "Enable or disable content safety checking. When enabled, defaults to `fast` mode.", "type": "boolean", "default": false }, "mode": { "description": "Safety checking mode for video generation.", "type": "string", "oneOf": [ { "const": "none", "title": "None", "description": "Disables checking." }, { "const": "fast", "title": "Fast", "description": "Checks key frames." }, { "const": "full", "title": "Full", "description": "Checks all frames." } ], "default": "none" } }, "additionalProperties": false } }, "required": [ "positivePrompt", "taskType", "taskUUID", "model" ], "allOf": [ { "dependentRequired": { "width": [ "height" ], "height": [ "width" ] } }, { "oneOf": [ { "title": "1080p (16:9)", "properties": { "width": { "const": 1920 }, "height": { "const": 1080 } } }, { "title": "1080p (1:1)", "properties": { "width": { "const": 1440 }, "height": { "const": 1440 } } }, { "title": "1080p (9:16)", "properties": { "width": { "const": 1080 }, "height": { "const": 1920 } } } ] }, { "if": { "properties": { "inputs": { "properties": { "frameImages": { "minItems": 1 } }, "required": [ "frameImages" ] } }, "required": [ "inputs" ] }, "then": { "not": { "anyOf": [ { "required": [ "width" ] }, { "required": [ "height" ] } ] } }, "else": { "required": [ "width", "height" ] } }, { "if": { "properties": { "inputs": { "anyOf": [ { "required": [ "video" ] }, { "required": [ "referenceVideos" ] } ] } }, "required": [ "inputs" ] }, "then": { "not": { "anyOf": [ { "properties": { "providerSettings": { "properties": { "klingai": { "required": [ "sound" ] } } } }, "required": [ "providerSettings" ] }, { "properties": { "providerSettings": { "properties": { "klingai": { "required": [ "multiPrompt" ] } } } }, "required": [ "providerSettings" ] } ] } } }, { "if": { "properties": { "inputs": { "required": [ "video" ] } }, "required": [ "inputs" ] }, "then": { "not": { "properties": { "inputs": { "required": [ "elements" ] } }, "required": [ "inputs" ] } } }, { "if": { "properties": { "providerSettings": { "properties": { "klingai": { "required": [ "keepOriginalSound" ] } } } }, "required": [ "providerSettings" ] }, "then": { "properties": { "inputs": { "anyOf": [ { "required": [ "video" ] }, { "required": [ "referenceVideos" ] } ] } }, "required": [ "inputs" ] } }, { "if": { "properties": { "inputs": { "anyOf": [ { "required": [ "video" ] }, { "required": [ "referenceVideos" ] } ] } }, "required": [ "inputs" ] }, "then": { "properties": { "inputs": { "properties": { "referenceImages": { "maxItems": 4 } } } } } }, { "if": { "properties": { "inputs": { "required": [ "referenceVideos" ] } }, "required": [ "inputs" ] }, "then": { "properties": { "providerSettings": { "properties": { "klingai": { "required": [ "characterOrientation" ] } } } }, "required": [ "providerSettings" ] } }, { "if": { "properties": { "providerSettings": { "properties": { "klingai": { "properties": { "characterOrientation": { "const": "image" } }, "required": [ "characterOrientation" ] } } } }, "required": [ "providerSettings" ] }, "then": { "properties": { "inputs": { "required": [ "referenceImages" ] } }, "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 klingai-video-o3-pro", "description": "Kling VIDEO O3 Pro is a unified multimodal video model that generates HD clips from text or images with native audio output. It prioritizes detail, motion realism, and stable subject identity, and it supports reference-driven generation plus prompt-based video editing with strong temporal consistency.", "operationId": "run_klingai_video_o3_pro", "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": [] } ] }