跳至主要內容
API 參考

Kling 文字轉影片

使用文字轉影片端點以建立非同步任務。

檢視 Markdown
01

概覽

使用文字轉影片端點配合受支援的模型。使用返回的任務 ID 來檢索其狀態，或提供 callback_url 以接收以下記錄的推送通知。

快速入門

  1. 建立 API 金鑰並將其設定為 RUNAPI_API_KEY。
  2. 選擇支援的模型，並發送主體符合該模型結構的 POST 請求。
  3. 儲存返回的任務 ID，然後輪詢直至達到終止狀態，或處理下方說明的回呼。

端點

POST /api/v1/kling/text_to_video
基礎 URL
https://runapi.ai
API 版本
v1
身份驗證
Authorization: Bearer YOUR_API_TOKEN
02

支援的模型

開啟模型頁面以查看當前定價、速率限制及商業用途詳情。

03

請求結構

JSON 內容

欄位及允許的值取決於所選模型。提供後，callback_url 將接收以下記錄的 Task 交付內容。

kling-3.014 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1
callback_urlstring
選填

用於非同步通知的 Webhook URL。

cfg_scalenumber
選填

引導比例（0-1）。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
enable_soundboolean
選填

啟用聲音生成。

first_frame_image_urlstring
選填

首幀圖像 URL。

kling_elementsarray
選填

包含圖像、影片或音訊素材的元素參考。

last_frame_image_urlstring
選填

單鏡頭模式的最後一幀圖片 URL。

modelstring
必填

模型標識符。

multi_promptarray
選填

多鏡頭模式的提示詞片段。

multi_shotsboolean
選填

啟用多鏡頭生成。

negative_promptstring
選填

負面提示。

output_resolutionstring
選填

輸出解析度。

允許值: 720p, 1080p, 4k
promptstring
選填

影片描述。除非已啟用 multi_shots，否則為必填項目。

kling-o111 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1 預設值: 16:9
callback_urlstring
選填

用於非同步通知的 Webhook URL。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 5 預設值: 5
enable_soundboolean
選填

聲音生成必須保持停用狀態。

預設值: false
modestring
選填

生成模式。

允許值: std, pro 預設值: std
modelstring
必填

模型標識符。

preserve_reference_video_audioboolean
選填

保留參考視訊的原始音訊。

預設值: false
promptstring
必填

影片描述；使用對應編號標記引用媒體。

範圍: 1 - 2500
reference_image_urlsarray
選填

有序的公開 HTTP(S) JPG、JPEG 或 PNG 參考圖片 URL。

項目範圍: 1 - 7
reference_video_typestring
選填

將影片用作基礎編輯或特徵參考。

允許值: base, feature 預設值: base
reference_video_urlstring
選填

公開 HTTP(S) MP4 或 MOV 參考視訊 URL。

kling-v2.1-master-text-to-video8 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1
callback_urlstring
選填

用於非同步通知的 Webhook URL。

cfg_scalenumber
選填

引導比例（0-1）。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 5, 10
enable_soundboolean
選填

啟用聲音生成。

modelstring
必填

模型標識符。

negative_promptstring
選填

負面提示。

promptstring
選填

影片描述。

kling-v2.5-turbo-text-to-video-pro8 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1
callback_urlstring
選填

用於非同步通知的 Webhook URL。

cfg_scalenumber
選填

引導比例（0-1）。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 5, 10
enable_soundboolean
選填

啟用聲音生成。

modelstring
必填

模型標識符。

negative_promptstring
選填

負面提示。

promptstring
選填

影片描述。

kling-v2.67 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1 預設值: 16:9
callback_urlstring
選填

用於非同步通知的 Webhook URL。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 5, 10 預設值: 5
enable_soundboolean
選填

啟用聲音生成；需要 pro 模式。

預設值: false
modestring
選填

生成模式。

允許值: std, pro 預設值: std
modelstring
必填

模型標識符。

promptstring
必填

影片描述。

範圍: 1 - 2500
kling-v3-omni7 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1 預設值: 16:9
callback_urlstring
選填

用於非同步通知的 Webhook URL。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 預設值: 5
enable_soundboolean
選填

啟用同步聲音生成。

預設值: false
modelstring
必填

模型標識符。

output_resolutionstring
選填

輸出解析度。

允許值: 720p, 1080p, 4k 預設值: 720p
promptstring
必填

影片描述。

範圍: 1 - 2500
kling-v3-omni-reference8 個欄位
aspect_ratiostring
必填

輸出長寬比。

允許值: 16:9, 9:16, 1:1
callback_urlstring
選填

用於非同步通知的 Webhook URL。

duration_secondsinteger
選填

輸出時長（秒）。

允許值: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 預設值: 5
enable_soundboolean
選填

啟用同步聲音生成。

預設值: false
modelstring
必填

模型標識符。

output_resolutionstring
選填

輸出解析度。

允許值: 720p, 1080p, 4k 預設值: 720p
promptstring
必填

影片描述。

範圍: 1 - 2500
reference_image_urlsarray
必填

有序的參考圖片 URL。

項目範圍: 1 - 7
kling-v3-turbo-text-to-video6 個欄位
aspect_ratiostring
選填

輸出長寬比。

允許值: 16:9, 9:16, 1:1 預設值: 16:9
callback_urlstring
選填

用於非同步通知的 Webhook URL。

duration_secondsinteger
選填

持續時間（秒）。

允許值: 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 預設值: 5
modelstring
必填

模型標識符。

output_resolutionstring
選填

輸出解析度。

允許值: 720p, 1080p 預設值: 720p
promptstring
必填

影片描述。

範圍: 1 - 2500

條件規則

當所有列出的條件均符合時，這些要求方才適用。

  1. 當 model = kling-3.0
    必填
    不接受
    reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
  2. 當 model = kling-o1
    必填
    不接受
    output_resolution, negative_prompt, cfg_scale, multi_shots, multi_prompt, first_frame_image_url, last_frame_image_url, kling_elements
  3. 當 model = kling-v2.1-master-text-to-video
    必填
    不接受
    mode, reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
  4. 當 model = kling-v2.5-turbo-text-to-video-pro
    必填
    不接受
    mode, reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
  5. 當 model = kling-v2.6
    必填
    不接受
    output_resolution, negative_prompt, cfg_scale, multi_shots, multi_prompt, first_frame_image_url, last_frame_image_url, kling_elements, reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
  6. 當 model = kling-v3-omni
    必填
    不接受
    negative_prompt, cfg_scale, multi_shots, multi_prompt, first_frame_image_url, last_frame_image_url, kling_elements, reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
  7. 當 model = kling-v3-turbo-text-to-video
    必填
    不接受
    enable_sound, negative_prompt, cfg_scale, multi_shots, multi_prompt, first_frame_image_url, last_frame_image_url, kling_elements, reference_image_urls, reference_video_url, reference_video_type, preserve_reference_video_audio
04

建立接受

HTTP 202

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}
05

輪詢處理中

HTTP 200

GET /api/v1/kling/text_to_video/:id

回應結構
JSON 
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}
06

輪詢已完成

HTTP 200

GET /api/v1/kling/text_to_video/:id

回應結構
JSON 
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "completed",
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
07

輪詢失敗

HTTP 200

GET /api/v1/kling/text_to_video/:id

回應結構
JSON 
{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}
08

客戶回呼：已完成

HTTP 200

POST callback_url

回應結構
JSON 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    },
    "videos": {
      "items": {
        "properties": {
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "status",
    "videos"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "id": "tsk_reference_demo",
  "status": "completed",
  "videos": [
    {
      "url": "https://file.runapi.ai/reference-video.mp4"
    }
  ]
}
09

客戶回呼：已失敗

HTTP 200

POST callback_url

回應結構
JSON 
{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}
10

錯誤

HTTP 401

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Authentication required"
}
11

錯誤

HTTP 401

GET /api/v1/kling/text_to_video/:id

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Authentication required"
}
12

錯誤

HTTP 400

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人類可讀的錯誤訊息。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人類可讀的驗證摘要。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "以公開請求欄位為鍵的驗證訊息，每個欄位對應一組人類可讀的字串陣列。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

回應範例

JSON 
{
  "error": "model must be one of: kling-3.0, kling-o1, kling-v2.1-master-text-to-video, kling-v2.5-turbo-text-to-video-pro, kling-v2.6, kling-v3-omni, kling-v3-omni-reference, kling-v3-turbo-text-to-video"
}
13

錯誤

HTTP 402

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Insufficient balance"
}
14

錯誤

HTTP 429

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "API key credit limit exceeded"
}
15

錯誤

HTTP 409

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "The request uses features that are not supported for the selected model"
}
16

錯誤

HTTP 429

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Rate limit reached. Please retry later."
}
17

錯誤

HTTP 503

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Service under maintenance, please try again later"
}
18

錯誤

HTTP 504

POST /api/v1/kling/text_to_video

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "The request timed out"
}
19

錯誤

HTTP 404

GET /api/v1/kling/text_to_video/:id

回應結構
JSON 
{
  "properties": {
    "error": {
      "description": "人類可讀的錯誤訊息。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

回應範例

JSON 
{
  "error": "Task with id 'tsk_reference_demo' not found"
}
20

已生成的程式碼範例

直接使用 cURL，或為您的語言安裝 SDK。每個範例均提交本參考中所示的已驗證請求。

安裝

Shell 
pip install runapi-kling
PYTHON 
import os
from runapi.kling import KlingClient

client = KlingClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.text_to_video.create(
  model="kling-v3-turbo-text-to-video",
  prompt="A paper kite flying above a quiet coastal town at sunrise",
  duration_seconds=5,
  aspect_ratio="16:9",
  output_resolution="720p"
)