VideoToolRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/kreatorflow-ai/json-schema/kreatorflow-ai-video-tool-request-schema.json",
  "title": "VideoToolRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kreatorflow-ai-openapi.json#/components/schemas/VideoToolRequest",
  "type": "object",
  "properties": {
    "model": {
      "type": "string",
      "description": "string optional; kreator-video-wan-3-prime or kreator-video-wan-3 (when enabled for your account)"
    },
    "source": {
      "type": "string",
      "description": "required; the clip: an upload_id from POST /v1/uploads (upload_type VIDEO), asset:<id>, generation:<id>, a kreatorflow.ai media link or an @handle. Public URLs are not accepted: upload the clip with POST /v1/uploads first. video / source_video / video_upload_id also accepted. MP4 or MOV, up to 15 s"
    },
    "instruction": {
      "type": "string",
      "description": "edit: required, what to change (up to 1500 characters); extend: optional, what happens in the new part. prompt / text also accepted. Name references as Image 1, Video 2, Audio 1 or by @handle"
    },
    "references": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Reference"
      },
      "description": "array optional; extra images, clips or audio in the same forms as source (uploaded with POST /v1/uploads, not public URLs), in prompt order after the clip"
    },
    "direction": {
      "type": "string",
      "description": "extend only: after (default), before or both"
    },
    "add_seconds": {
      "type": "string",
      "description": "extend only: seconds to add, at least 2; the clip plus the result stay within 30 s"
    },
    "resolution": {
      "type": "string",
      "description": "720p (default) or 1080p; anything else is refused with 400 resolution_not_supported before anything is reserved"
    },
    "aspect_ratio": {
      "type": "string",
      "description": "optional; 16:9, 9:16, 1:1, 4:3, 3:4 or 21:9 (default: keep the clip's shape); anything else is refused with 400 aspect_ratio_not_supported"
    },
    "seed": {
      "type": "integer",
      "description": "integer optional"
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "description": "https url optional; receives terminal job callbacks"
    },
    "idempotency_key": {
      "type": "string",
      "description": "string optional body fallback; prefer Idempotency-Key header"
    }
  },
  "required": [
    "source"
  ],
  "additionalProperties": true,
  "$defs": {
    "Reference": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "image_url",
            "video_url",
            "audio_url"
          ]
        },
        "url": {
          "type": "string",
          "description": "public https url"
        },
        "upload_id": {
          "type": "string",
          "description": "workspace-scoped upload_id returned by POST /v1/uploads"
        },
        "role": {
          "type": "string",
          "description": "optional content role such as first_frame, last_frame, reference_image, reference_video, reference_audio"
        }
      },
      "additionalProperties": true
    }
  }
}