Developer Docs/Kling Omni API

Kling Omni API

Build Kling Omni integrations with A2E. Review authentication, request parameters, task creation, status, and result endpoints.

Overview

An extended variant of Kling with additional control parameters for output style, generation quality, and advanced scene handling.

Primary Endpoint

POST/api/v1/klingOmni/start

Start Kling Omni video generation

Request Parameters

NameTypeRequiredDescription
namestringNoTask name (internal use)
promptstringNoText prompt. Use <<<image_N>>> to reference images. Required when multi_shot=false or shot_type=intelligence.
image_listarray<string>NoReference image URLs (up to 7, jpg/jpeg/png, max 10MB). Simplified: pass URLs directly; server converts to official [{image_url}] format.
modeenum: std | proNoVideo generation mode. std=standard (720p), pro=professional (1080p)
durationstringNoVideo duration in seconds (3–15)
aspect_ratioenum: 16:9 | 9:16 | 1:1No-
soundbooleanNoEnable native sound generation. Simplified: pass boolean; server converts to official 'on'/'off'.
multi_shotbooleanNoEnable multi-shot mode
shot_typeenum: intelligence | customizeNoShot type. Required when multi_shot=true.
multi_promptarray<object>NoManual storyboard (required when shot_type=customize, 1–6 items, total duration must equal duration). Server auto-adds index field for official API.
webhook_urlstringNoHTTPS URL to receive task.completed / task.failed notifications. Best-effort delivery, single attempt, no retries; clients should treat the detail API as the source of truth.
webhook_tokenstringNoOptional plaintext token returned in the X-A2e-Webhook-Token header so receivers can verify the request originated from a2e.

Request Example

curl -X POST "https://www.a2e.com.cn/api/v1/klingOmni/start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My Kling Omni Video",
  "prompt": "<<<image_1>>> walks towards <<<image_2>>> in a sunny park",
  "image_list": [
    "https://example.com/ref1.jpg"
  ],
  "mode": "std",
  "duration": "5",
  "aspect_ratio": "16:9",
  "sound": false,
  "multi_shot": false,
  "shot_type": "intelligence",
  "multi_prompt": "A cinematic scene with natural motion",
  "webhook_url": "https://your-server.example.com/a2e/webhook",
  "webhook_token": "a-shared-secret"
}'

Related Endpoints

POST/api/v1/klingOmni/start

Start Kling Omni video generation

GET/api/v1/klingOmni/allRecords

Get all Kling Omni video records

POST/api/v1/klingOmni/batchDetail

Batch get Kling Omni video details

GET/api/v1/klingOmni/{_id}

Get Kling Omni video detail

PUT/api/v1/klingOmni/{_id}

Update Kling Omni video name

DELETE/api/v1/klingOmni/{_id}

Delete Kling Omni video

Responses

200

Video generation task started successfully

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid or missing bearer token