> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Kling のテキストから動画へのタスクを作成する
> CometAPI の POST /kling/v1/videos/text2video を使用して、Kling でテキストプロンプトから動画を生成し、その後 task ID でタスク状態を追跡して結果を取得します。
このエンドポイントを使用すると、プロンプトから Kling のテキストから動画へのタスクを作成できます。完成済みの動画をすぐに返すのではなく、非同期ジョブを開始します。
## 最初に動かすリクエスト
* まずは短いプロンプトを送信します
* 最初は `kling-v3` の例から始め、別のモデル系統が必要になったら OpenAPI の enum から別の `model_name` を選択します
* 基本のフローが動作してから `aspect_ratio`、`duration`、`mode`、`sound` を追加します
* 純粋なポーリングではなくプッシュ配信を使いたい場合は `callback_url` を設定します
* 生成音声をサポートするモデルで、音声なしの決定的な初回リクエストにしたい場合は `sound: off` を使用します
## モデル命名
このエンドポイントでは通常の Kling 動画 model ID を使用します。Omni model ID は [Omni Video](./omni-video) 用にしてください。
## 再生時間とアスペクト比
| Setting | Supported values | Default | Boundary behavior |
| -------------- | --------------------- | ------------- | -------------------------------------- |
| `duration` | `5`, `10` | `5` | それ以外の値は、テキストから動画へのリクエストの shape の対象外です。 |
| `aspect_ratio` | `16:9`, `9:16`, `1:1` | `16:9` | 配信先の表示面に合った比率を使用してください。 |
| `mode` | `std`, `pro` | `std` | `pro` は品質が向上しますが、コストも高くなります。 |
| `sound` | `on`, `off` | model default | 生成音声をサポートするモデル系統にのみ適用されます。 |
このエンドポイントでは、個別の解像度トークンや厳密な `size` フィールドは公開されていません。指定したアスペクト比によって、出力フレームの形状が制御されます。
| `aspect_ratio` | Typical rendered `WxH` |
| -------------- | ---------------------- |
| `16:9` | `1280x720` |
| `9:16` | `720x1280` |
| `1:1` | `960x960` |
## タスクフロー
このエンドポイントを通じてタスクを作成し、返された Kling task id を保存します。
タスクが終端状態に達するまで、[Get a Kling task](./individual-queries) を通じて進行状況を確認します。
Kling が完成したアセットのメタデータを返したら、長期保存が必要な場合は結果を自分のストレージに移動します。
完全なパラメータ一覧とモデル系統の詳細については、[Kling 公式ドキュメント](https://kling.ai/document-api/apiReference/model/textToVideo)を参照してください。
## OpenAPI
````yaml api/openapi/video/kling/post-text-to-video.openapi.json POST /kling/v1/videos/text2video
openapi: 3.1.0
info:
title: Text to Video API
version: 1.0.0
servers:
- url: https://api.cometapi.com
security:
- bearerAuth: []
paths:
/kling/v1/videos/text2video:
post:
summary: Text to Video
operationId: text_to_video
parameters:
- name: Content-Type
in: header
required: false
description: Must be `application/json`.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- prompt
properties:
prompt:
type: string
description: >-
Text prompt describing the video to generate. Maximum 500
characters.
negative_prompt:
type: string
description: Elements to exclude from the video. Maximum 200 characters.
aspect_ratio:
type: string
description: >-
Aspect ratio request. Typical rendered sizes are 1280x720
for 16:9, 720x1280 for 9:16, and 960x960 for 1:1. This
endpoint does not expose an exact size field.
enum:
- '16:9'
- '9:16'
- '1:1'
callback_url:
type: string
description: >-
Webhook URL to receive task status updates when the task
completes.
model_name:
type: string
description: >-
Model ID for this text-to-video request. Use an ordinary
Kling video model ID; use Omni model IDs only with the Omni
Video endpoint.
enum:
- kling-v1
- kling-v1-6
- kling-v2-master
- kling-v2-1-master
- kling-v2-5-turbo
- kling-v2-6
- kling-v3
default: kling-v1
cfg_scale:
type: number
description: >-
Prompt adherence strength. Higher values follow the prompt
more closely. Range: 0–1.
mode:
type: string
description: >-
Generation mode. `std` for standard (faster), `pro` for
professional (higher quality). The default is `std`.
enum:
- std
- pro
default: std
duration:
type: string
description: >-
Output video length in seconds. Use `5` or `10`; omit to use
`5`.
default: '5'
camera_control:
type: object
description: >-
Camera motion preset or manual configuration. Omit for
automatic camera movement.
properties:
type:
type: string
description: Preset camera motion type.
enum:
- simple
- down_back
- forward_up
- right_turn_forward
- left_turn_forward
config:
type: object
description: >-
Manual camera movement axes. Each value ranges from -10
to 10.
properties:
horizontal:
type: integer
description: >-
Horizontal dolly (truck). Negative = left, positive
= right. Range: -10 to 10.
vertical:
type: integer
description: >-
Vertical dolly (pedestal). Negative = down, positive
= up. Range: -10 to 10.
pan:
type: integer
description: >-
Horizontal rotation (pan). Negative = left, positive
= right. Range: -10 to 10.
tilt:
type: integer
description: >-
Vertical rotation (tilt). Negative = down, positive
= up. Range: -10 to 10.
roll:
type: integer
description: >-
Axial rotation (roll). Negative = counter-clockwise,
positive = clockwise. Range: -10 to 10.
zoom:
type: integer
description: >-
Zoom. Negative = zoom out, positive = zoom in.
Range: -10 to 10.
external_task_id:
type: string
description: >-
Custom task id for your own tracking. Does not replace the
system-generated task id but can be used to query tasks.
Must be unique per user.
sound:
type: string
description: >-
Optional generated-audio switch for models that support
video sound. Use `on` or `off`, or omit the field for the
model default.
enum:
- 'on'
- 'off'
default:
prompt: >-
A small ceramic cup on a wooden table, steam rising in soft
morning light
model_name: kling-v3
mode: std
duration: '5'
sound: 'off'
examples:
Default:
summary: Kling V3 text-to-video request with generated sound disabled
value:
prompt: >-
A small ceramic cup on a wooden table, steam rising in soft
morning light
model_name: kling-v3
mode: std
duration: '5'
sound: 'off'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: Error code; specifically define the error code
message:
type: string
description: error message
request_id:
type: string
description: >-
Request ID, system-generated, for tracking requests,
troubleshooting issues
data:
type: object
properties:
task_id:
type: string
description: Task ID, system generated
task_status:
type: string
description: >-
Task status, enumerated values: submitted, processing,
succeed, failed.
created_at:
type: integer
description: Task creation time, Unix timestamp, in ms.
updated_at:
type: integer
description: Task update time, Unix timestamp, in ms.
x-codeSamples:
- lang: Shell
label: Default
source: |
curl https://api.cometapi.com/kling/v1/videos/text2video \
-H "Authorization: Bearer $COMETAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "A small ceramic cup on a wooden table, steam rising in soft morning light",
"model_name": "kling-v3",
"mode": "std",
"duration": "5",
"sound": "off"
}'
- lang: Python
label: Default
source: |
import os
import requests
response = requests.post(
"https://api.cometapi.com/kling/v1/videos/text2video",
headers={"Authorization": "Bearer " + os.environ["COMETAPI_KEY"]},
json={
"prompt": "A small ceramic cup on a wooden table, steam rising in soft morning light",
"model_name": "kling-v3",
"mode": "std",
"duration": "5",
"sound": "off"
},
)
result = response.json()
print(result.get("code"), result.get("data", {}).get("task_id"))
- lang: JavaScript
label: Default
source: >
const response = await
fetch("https://api.cometapi.com/kling/v1/videos/text2video", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.COMETAPI_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"prompt": "A small ceramic cup on a wooden table, steam rising in soft morning light",
"model_name": "kling-v3",
"mode": "std",
"duration": "5",
"sound": "off"
}),
});
const result = await response.json();
console.log(result.code, result.data?.task_id);
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Bearer token authentication. Use your CometAPI key.
````