Skip to main content

Kling API Python SDK for RunAPI

The Kling Python SDK is the language-specific package for Kling on RunAPI. Use this package for video generation, animation, and video editing workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Python.

This README is the Python package guide inside the public kling-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/kling; for API reference, use https://runapi.ai/docs#kling; for SDK docs, use https://runapi.ai/docs#sdk-kling.

Install

pip install runapi-kling

Quick start

from runapi.kling import KlingClient

client = KlingClient()  # reads RUNAPI_API_KEY, or pass api_key="sk-..."

task = client.text_to_video.create(
    model="kling-3.0",
    prompt="A cat walking through a garden",
)
status = client.text_to_video.get(task.id)

avatar = client.ai_avatar.create(
    model="kling-ai-avatar-pro",
    prompt="A friendly host greeting the audience",
    source_image_url="https://cdn.runapi.ai/public/samples/portrait.jpg",
    source_audio_url="https://cdn.runapi.ai/public/samples/voice.mp3",
)

Kling O1 reference media

result = client.text_to_video.run(
    model="kling-o1",
    prompt="Keep <<<image_1>>> beside the performer from <<<video_1>>>",
    reference_image_urls=["https://cdn.runapi.ai/public/samples/portrait.jpg"],
    reference_video_url="https://cdn.runapi.ai/public/samples/video.mp4",
    reference_video_type="feature",
    preserve_reference_video_audio=True,
    mode="pro",
    duration_seconds=5,
)

Number reference images in prompt order as <<<image_1>>>, <<<image_2>>>, and so on; the optional video is <<<video_1>>>. With a video, send at most four images. Do not combine last_frame_image_url with reference images or a reference video. A feature reference video may be used with the required first frame; base cannot be combined with frame inputs. O1 requests are five seconds and keep sound disabled. Pricing and limits: https://runapi.ai/models/kling/o1.

Use create when you want to submit a task and return quickly, get when you need the latest task state, and run when a script should create and poll until completion:

result = client.text_to_video.run(
    model="kling-3.0",
    prompt="A serene drone shot over a misty forest",
)
print(result.videos[0].url)

In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.

RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.

Language notes

Pass parameters as keyword arguments and catch the runapi.kling error classes when building video jobs, workers, or scripts. The available resources are text_to_video, ai_avatar, image_to_video, and motion_control. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.

Links

License

Licensed under the Apache License, Version 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runapi_kling-0.2.1.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runapi_kling-0.2.1-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file runapi_kling-0.2.1.tar.gz.

File metadata

  • Download URL: runapi_kling-0.2.1.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_kling-0.2.1.tar.gz
Algorithm Hash digest
SHA256 69160a618e70ec58c7fe6d6747f808c2ea83f6b6bf8b24da46c5a9d47e9e6f45
MD5 056d520e591f5829f61cb8a47d959ef8
BLAKE2b-256 c53c382931fde2f5d30ba11d69c16187ec4e68b68070126a23d8c27cc342f6fc

See more details on using hashes here.

File details

Details for the file runapi_kling-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: runapi_kling-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.31 {"installer":{"name":"uv","version":"0.11.31","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runapi_kling-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8cfa85f3b27ac29a602ec4f3e499f8a87adc1abe3568429e7035ad4b4a46114e
MD5 a2aa363fa44fc92a6cf3312de56618c2
BLAKE2b-256 4e2964cf1d565088de14bc61b3feb52534ae8e536656850b36e03940aea05d71

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.1

2 files

0.3.0

2 files

0.2.2

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page