Skip to content

Kling 3.0 Omni Text to Video ​

This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.

Endpoint ​

POST /jobs/createTask

Full URL: https://ai.modelfold.online/v1/jobs/createTask

Authentication: every request must include the Authorization: Bearer <API_KEY> header.

Query Task Status ​

After submitting a task, you can check the task progress and retrieve generation results via the unified query endpoint:

  • Get Task Details — Learn how to query task status and obtain generation results

TIP

For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

Request Parameters ​

Body (application/json) ​

ParameterTypeRequiredDescription
modelstringYesThe name of the model used to generate the task. This field is required.
- This endpoint requires the kling-3.0-omni/text-to-video model Default:"kling-3.0-omni/text-to-video"。 Allowed values:kling-3.0-omni/text-to-video。 示例:kling-3.0-omni/text-to-video。
callBackUrlstringNoThe URL to receive generation task completion updates. Optional but recommended for production use.
- System will POST task status and results to this URL when generation completes
- Callback includes generated content URLs and task information
- Your callback endpoint should accept POST requests with JSON payload containing results
- Alternatively, use the Get Task Details endpoint to poll task status
- To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例:https://your-domain.com/api/callback。
inputobjectYesInput parameter configuration for the generation task. Rules: (1) customize_multi_shots and prefer_multi_shots cannot both be true; (2) customize_multi_shots = true requires 1–6 multi_prompt shots (each 1–12 s, total ≤ 15 s); (3) otherwise omit multi_prompt.

Request Example ​

bash
curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "kling-3.0-omni/text-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A wide shot of the fox entering the snowy forest.",
    "customize_multi_shots": true,
    "multi_prompt": [
      {
        "prompt": "A wide shot of the fox entering the snowy forest.",
        "duration": 2
      },
      {
        "prompt": "A cinematic close-up of the fox looking toward the sunrise.",
        "duration": 3
      }
    ],
    "audio": false,
    "resolution": "720p",
    "aspect_ratio": "16:9",
    "duration": 5
  }
}'
json
{
  "model": "kling-3.0-omni/text-to-video",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A wide shot of the fox entering the snowy forest.",
    "customize_multi_shots": true,
    "multi_prompt": [
      {
        "prompt": "A wide shot of the fox entering the snowy forest.",
        "duration": 2
      },
      {
        "prompt": "A cinematic close-up of the fox looking toward the sunrise.",
        "duration": 3
      }
    ],
    "audio": false,
    "resolution": "720p",
    "aspect_ratio": "16:9",
    "duration": 5
  }
}

Response ​

200 — Request Successful ​

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_kling-2.6_1765182425861"
  }
}

Callback ​

videoTaskCompleted ​

Callback URL: {request.body#/callBackUrl} (the callBackUrl in the request body).

The system sends this callback when the kling-3.0-omni/text-to-video task succeeds or fails.

Callback body parameters

参数类型必填说明
codeinteger是Unified callback code: 200 for success, 501 for failure. Allowed values:200 / 501。 示例:200。
msgstring是Unified callback message. Allowed values:Playground task completed successfully. / Playground task failed.。 示例:Playground task completed successfully.。
dataobject是—
  data.taskIdstring是The unique task identifier.
  data.modelstring是The model used for the task. Allowed values:kling-3.0-omni/text-to-video。 示例:kling-3.0-omni/text-to-video。
  data.statestring是Terminal task state. Allowed values:success / fail。 示例:success。
  data.paramstring是JSON string containing the submitted task parameters.
  data.resultJsonstring否JSON string containing resultUrls, firstFrameUrl, lastFrameUrl, or resultObject when successful. Present only when state is success.
  data.failCodestring否Failure code, a numeric string such as "400" or "500". Present only when state is fail.
  data.failMsgstring否Failure reason. Present only when state is fail.
  data.costTimeinteger否Processing time in seconds. Present on both success and failure callbacks.
  data.completeTimeinteger否Task completion timestamp.
  data.createTimeinteger否Task creation timestamp.
  data.updateTimeinteger否Use completeTime as the completion time; updateTime may equal createTime.
  data.creditsConsumednumber否Credits consumed by the task; 0 for failed tasks.

Task completed successfully

json
{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "kling-3.0-omni/text-to-video",
    "state": "success",
    "param": "{\"input\":\"{\\\"prompt\\\":\\\"A wide shot of the fox entering the snowy forest.\\\",\\\"customize_multi_shots\\\":true,\\\"multi_prompt\\\":[{\\\"prompt\\\":\\\"A wide shot of the fox entering the snowy forest.\\\",\\\"duration\\\":2},{\\\"prompt\\\":\\\"A cinematic close-up of the fox looking toward the sunrise.\\\",\\\"duration\\\":3}],\\\"audio\\\":false,\\\"resolution\\\":\\\"720p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"kling-3.0-omni/text-to-video\"}",
    "resultJson": "{\"resultUrls\":[\"https://example.com/generated-video.mp4\"]}",
    "costTime": 12,
    "completeTime": 1234567890,
    "createTime": 1234560000,
    "updateTime": 1234567890,
    "creditsConsumed": 1.23
  }
}

Task failed

json
{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "task_example_video_webhook_001",
    "model": "kling-3.0-omni/text-to-video",
    "state": "fail",
    "param": "{\"input\":\"{\\\"prompt\\\":\\\"A wide shot of the fox entering the snowy forest.\\\",\\\"customize_multi_shots\\\":true,\\\"multi_prompt\\\":[{\\\"prompt\\\":\\\"A wide shot of the fox entering the snowy forest.\\\",\\\"duration\\\":2},{\\\"prompt\\\":\\\"A cinematic close-up of the fox looking toward the sunrise.\\\",\\\"duration\\\":3}],\\\"audio\\\":false,\\\"resolution\\\":\\\"720p\\\",\\\"aspect_ratio\\\":\\\"16:9\\\",\\\"duration\\\":5}\",\"callBackUrl\":\"https://example.com/callback\",\"model\":\"kling-3.0-omni/text-to-video\"}",
    "failCode": "400",
    "failMsg": "<error detail>",
    "costTime": 12,
    "creditsConsumed": 0
  }
}

ModelFold — one API for all the best AI models.