Kling Image API Documentation

Overview

Generate high-fidelity images with Kling using prompt, aspect ratio, resolution, and optional reference-image controls.

Primary Endpoint

POST/api/v1/userKlingImage/start

Create one or more asynchronous Kling 3.0 image tasks from the prompt and optional reference images, subject to the request's `n` limit. ### Request - Send a valid bearer token. The server evaluates the operation in the authenticated caller's access context. - Send an `application/json` body. Required fields: `name`, `prompt`. - API-token callers may include `webhook_url` and `webhook_token` for best-effort terminal-state notifications; ordinary JWT/cookie calls ignore these fields. ### Behavior - This is an asynchronous operation: a successful submission creates a task and returns before processing finishes. - Persist the returned task identifier and use the corresponding detail or list operation to observe progress. - Treat the detail endpoint as the source of truth even when webhook delivery is enabled. ### Response - A `200` response confirms task acceptance; it does not by itself mean media generation has completed. - Retain the returned identifier and wait for a documented terminal status before using output URLs. - JSON object responses, including error responses, normally carry a top-level `trace_id` string for this request; include it when contacting support. It is not a task identifier. - Do not infer undocumented fields or statuses; clients should tolerate additional response properties. ### Errors - `401` — Unauthorized - Invalid or missing JWT token. ### Related Operations - `GET /api/v1/userKlingImage/list` — List Kling image tasks. - `GET /api/v1/userKlingImage/detail/{id}` — Get Kling image task details. - `DELETE /api/v1/userKlingImage/{id}` — Delete a Kling image task. Authentication: set header Authorization: Bearer <token> (supports user JWT or sk_ API token).

Request Parameters

Name	Type	Required	Description
name	string	Yes	Task name
prompt	string	Yes	Image generation prompt
creation_mode	enum: text-to-image \| image-edit	No	Optional compatibility field for history and mode reporting; callers may omit it. The server ignores any supplied value and records `image-edit` when `input_images` contains a valid HTTP(S) image URL, otherwise `text-to-image`. It is not forwarded to the model provider.
input_images	array<string>	No	Optional public reference image URLs
aspect_ratio	enum: 1:1 \| 16:9 \| 9:16 \| 4:3 \| 3:4 \| 2:3 \| 3:2 \| 21:9	No	default: "9:16"
resolution	enum: 1k \| 2k	No	default: "1k"
n	integer	No	minimum: 1; maximum: 9
webhook_url	string	No	HTTPS 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.; maxLength: 2048
webhook_token	string	No	Optional plaintext token returned in the X-A2e-Webhook-Token header so receivers can verify the request originated from a2e.; maxLength: 256

Request schema and conditional rules

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Task name"
        },
        "prompt": {
          "type": "string",
          "description": "Image generation prompt"
        },
        "creation_mode": {
          "type": "string",
          "enum": [
            "text-to-image",
            "image-edit"
          ],
          "description": "Optional compatibility field for history and mode reporting; callers may omit it. The server ignores any supplied value and records `image-edit` when `input_images` contains a valid HTTP(S) image URL, otherwise `text-to-image`. It is not forwarded to the model provider."
        },
        "input_images": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Optional public reference image URLs"
        },
        "aspect_ratio": {
          "type": "string",
          "enum": [
            "1:1",
            "16:9",
            "9:16",
            "4:3",
            "3:4",
            "2:3",
            "3:2",
            "21:9"
          ],
          "default": "9:16"
        },
        "resolution": {
          "type": "string",
          "enum": [
            "1k",
            "2k"
          ],
          "default": "1k"
        },
        "n": {
          "type": "integer",
          "minimum": 1,
          "maximum": 9
        }
      },
      "required": [
        "name",
        "prompt"
      ]
    },
    {
      "$ref": "#/components/schemas/WebhookInput"
    }
  ]
}

Response Fields

code: enum: 0
data: array<object>
data[]._id: string: Task ID for detail and batch polling.
data[].name: string
data[].prompt: string
data[].is_downloaded: boolean
data[].is_previewed: boolean
data[].current_status: string: Persisted task state; use the concrete task family schema for its allowed values and terminal states.
data[].createdAt: string
data[].updatedAt: string
data[].expirationDate: string
data[].remainingDays: number
data[].isExpired: boolean
data[].coins: number
data[].hasRefundCoin: boolean: Whether charged credits were refunded.
data[].failed_code: string
data[].failed_message: string
data[].failed_reason: string: Public failure category when available.
data[].creation_mode: string
data[].image_url: string
data[].image_urls: array<string>
data[].result_image_url: string
data[].result_image_urls: array<string>
data[].input_images: array<string>
trace_id: string: Trace ID of this HTTP request. Include it when contacting support about this request. It is generated per request and is not a task identifier; use the returned task `_id` to query results.

Request Example

curl -X POST "https://www.a2e.com.cn/api/v1/userKlingImage/start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "My Task",
  "prompt": "high quality, clear, cinematic"
}'

Related Endpoints

GET/api/v1/userKlingImage/detail/{id}

Get Kling image task details

POST/api/v1/userKlingImage/start

Start Kling 3.0 image generation

GET/api/v1/userKlingImage/list

List Kling image tasks

POST/api/v1/userKlingImage/batchDetail

Batch get Kling image task details

DELETE/api/v1/userKlingImage/{id}

Delete a Kling image task

Responses

200

Task created successfully

401

Unauthorized - Invalid or missing bearer token