Kling O3 uses the model ID kling-video/o3/image-reference. Kling O3 Image Reference generates videos from one or multiple images using customizable prompts and settings like duration, aspect ratio, and sound. It supports both single and multi-shot workflows with options for intelligent or customized shot types.
1. Calling the API
Send requests to https://api.higgsfield.ai/kling-video/o3/image-reference with a JSON body matching the parameters below.
Install
Install an official server-side SDK. cURL needs no package.
npm install @higgsfield/clientSetup
Keep credentials in server-side environment variables. The SDKs accept the same KEY_ID:KEY_SECRET value under their documented variable names.
export HF_CREDENTIALS="YOUR_KEY_ID:YOUR_KEY_SECRET" # TypeScript
export HF_KEY="YOUR_KEY_ID:YOUR_KEY_SECRET" # Python and cURLRequest parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mode | string | No | "std" | Options: std, pro, 4k. |
sound | string | No | "off" | Options: on, off. |
prompt | string | No | — | Prompt. |
duration | integer | No | 5 | Duration. Minimum: 3. Maximum: 15. |
elements | array[string] | No | — | |
shot_type | string | No | "customize" | Options: customize, intelligent. |
image_urls | array[string] | No | — | |
multi_shots | boolean | No | false | |
aspect_ratio | string | No | — | Options: 16:9, 9:16, 1:1. |
multi_prompt | array[object] | No | — | |
last_frame_url | string | No | — | Last frame URL. |
first_frame_url | string | No | — | First frame URL. |
2. Authentication
The official SDKs read credentials from the server environment and send the required Authorization: Key KEY_ID:KEY_SECRET header.
API Key
Never expose the secret in browser-side code or commit it to source control. The TypeScript SDK is server-side only. For direct HTTP calls, use:
Authorization: Key $HF_KEY3. Queue
subscribe submits the asynchronous request and waits for a terminal result. The TypeScript SDK polls automatically when withPolling: true; the Python SDK's synchronous subscribe call also waits. A completed request returns the generated file in the video field.
Submit and wait
import { config, higgsfield } from "@higgsfield/client/v2";
config({
credentials: process.env.HF_CREDENTIALS,
});
const result = await higgsfield.subscribe(
"kling-video/o3/image-reference",
{
input: {
"mode": "std",
"sound": "off",
"duration": 5,
"shot_type": "customize",
"multi_shots": false
},
withPolling: true,
},
);
console.log(result);Explicit lifecycle control
Use the Python SDK when a worker needs explicit status, result, or cancellation control for an existing request. The TypeScript v2 client currently exposes automatic polling through subscribe.
import higgsfield_client
request_id = "{request_id}"
status = higgsfield_client.status(request_id=request_id)
result = higgsfield_client.result(request_id=request_id)
higgsfield_client.cancel(request_id=request_id)