Skip to main content
Video models

Kling O3 — Video reference API

Video reference with Kling O3: request parameters, examples and response handling.

← Kling O3

Endpoint: POST https://api.higgsfield.ai/kling-video/o3/video-reference

Endpoint ID: kling-video/o3/video-reference

▶Open API PlaygroundKling O3 · Video reference↗

#Usage notes

  • Supply exactly one video reference. duration controls the generated clip and accepts integer values from 3 to 10 seconds.
  • You may also supply up to four image_urls and up to four elements.
  • Keep the top-level prompt within 2,500 characters; longer prompts are truncated.
  • elements contains Kling element IDs as decimal strings. Each ID must belong to the account making the request; arbitrary provider IDs are rejected.
  • The example.com media URLs are placeholders. Replace them with public HTTPS URLs to your own media before submitting.

#Quick start

Replace the example media URLs with publicly accessible URLs for your own files before submitting.

cURL
curl --request POST \
  --url https://api.higgsfield.ai/kling-video/o3/video-reference \
  --header "Authorization: Key ${HF_API_KEY_ID}:${HF_API_KEY_SECRET}" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: ${IDEMPOTENCY_KEY}" \
  --data '{
  "prompt": "A slow cinematic camera move around the subject in warm evening light.",
  "video_urls": [
    "https://example.com/source-video.mp4"
  ]
}'

#Input schema

mode string (default: pro)

Allowed values: "std", "pro".

prompt string required

Write your prompt here

duration integer (default: 5)

Requested output duration in seconds. Minimum: 3. Maximum: 10.

elements array

Minimum items: 0. Maximum items: 4. Each item: string.

image_urls array

Ordered public image reference URLs. Minimum items: 0. Maximum items: 4. Each item: string. Format: uri.

video_urls array required

Ordered public video reference URLs. Minimum items: 1. Maximum items: 1. Each item: string. Format: uri.

aspect_ratio string

Output width-to-height ratio. Allowed values: "16:9", "9:16", "1:1".

Complete JSON schema
json
{
  "type": "object",
  "title": "Kling O3 Playground",
  "required": [
    "prompt",
    "video_urls"
  ],
  "properties": {
    "mode": {
      "enum": [
        "std",
        "pro"
      ],
      "type": "string",
      "default": "pro"
    },
    "prompt": {
      "type": "string",
      "title": "Prompt",
      "description": "Write your prompt here"
    },
    "duration": {
      "type": "integer",
      "title": "Duration",
      "default": 5,
      "maximum": 10,
      "minimum": 3
    },
    "elements": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 4,
      "minItems": 0
    },
    "image_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "title": "Image URL",
        "format": "uri"
      },
      "maxItems": 4,
      "minItems": 0
    },
    "video_urls": {
      "type": "array",
      "items": {
        "type": "string",
        "title": "Video URL",
        "format": "uri"
      },
      "maxItems": 1,
      "minItems": 1
    },
    "aspect_ratio": {
      "enum": [
        "16:9",
        "9:16",
        "1:1"
      ],
      "type": "string"
    }
  }
}

#Response

Submission returns a request handle. Poll status_url until status is completed, or use webhooks.

Accepted
{
  "status": "queued",
  "request_id": "REQUEST_ID",
  "status_url": "https://api.higgsfield.ai/requests/REQUEST_ID/status",
  "cancel_url": "https://api.higgsfield.ai/requests/REQUEST_ID/cancel"
}

A completed response includes the following output fields:

json
{
  "status": "completed",
  "request_id": "REQUEST_ID",
  "video": {
    "url": "https://example.com/output.mp4"
  }
}

See idempotent requests, polling, request errors and authentication for shared request handling.

Was this page helpful?
Navigation