> For the complete documentation index, see [llms.txt](https://kreadoai.gitbook.io/developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kreadoai.gitbook.io/developers/kreadoai-mcp/mcp-types/kreadoai-mcp-and-skills-documentation.md). # KreadoAI MCP & Skills Documentation ## 1. Quick Start Welcome to the KreadoAI MCP & Skills Documentation! 🙌 This guide will help you quickly integrate KreadoAI's MCP services and Skills capabilities. It covers authentication, MCP architecture, API tools, usage examples, and best practices for building AI-powered workflows. Whether you're generating marketing assets, creating digital human videos, or building AI agents, this documentation provides everything you need to get started. 👉 Submit your integration requirements here, and our team will contact you within 24 business hours: #### 1.1 Create an Account Create a KreadoAI account and upgrade to a Professional Plan. With KreadoAI's powerful AI capabilities, you can create: * Digital human videos * AI-generated marketing assets * AI voiceovers * AI image and video content * Automated content production workflows #### 1.2 Obtain Your API Key After logging into your KreadoAI account, navigate to: **Account Overview → API Settings** to generate and manage your API credentials. #### 1.3 Important Notes * Temporary request failures may occur during service upgrades or maintenance periods. We recommend implementing a retry mechanism. * Please control request concurrency appropriately. If rate limits are triggered, avoid continuous retries, as this may prolong the cooldown period. ## 2. MCP Endpoint To access KreadoAI MCP services, all requests must be authenticated using HTTP headers. #### MCP Configuration Example ``` { "mcpServers": { "aigc-agent-art": { "url": "https://api.kreadoai.com/mcp/agentart/v1/mcp", "headers": { "apiToken": "api秘钥" } } } } ``` #### Supported MCP Clients KreadoAI MCP can be integrated with: * Cursor * Claude * Custom AI Agens * Any MCP-compatible client ## 3. AI Image Generation ### Use Cases Generate: * Advertising creatives * Marketing posters * Product images * Brand visuals * E-commerce product listings * Social media assets Supports: * Text-to-Image (T2I) * Image-to-Image (I2I) Reference images can be provided using: * Image URL * Base64-encoded image Supported models: * GPT Image * Gemini * Doubao Seedream ### MCP Tools #### 3.1 get\_my\_user\_detail Retrieves detailed information for the currently authenticated user. Returns: * Account information * Email address * Phone number * Membership level * Remaining K Coins * Available quotas * Registration source Notes: * Authentication is based on the current session context. * `userId` cannot be provided manually. * Accessing other users' information is not supported. #### 3.2 submit\_ai\_image\_task Creates an AI image generation task and returns a task ID. Supported features: * Text-to-Image generation * Image-to-Image generation * URL reference images * Base64 reference images #### 3.3 get\_ai\_image\_task\_detail Retrieves task execution results. Returns: | Status | Description | | ------ | ----------- | | 1 | Pending | | 2 | Processing | | 3 | Completed | | 4 | Failed | Additional fields: * Generated image URL * Prompt * Model provider #### 3.4 resubmit\_ai\_image\_task Recreates an image generation task using the original task parameters. Returns a new task ID. Only tasks owned by the current user may be regenerated. ## 4. Multi-Size Ad Creative Generation #### Use Cases > KreadoAI AI Ad Creative Batch Image Generation allows you to upload product images and specify a list of target sizes to generate multiple ad creatives in a single batch. > > It supports common advertising asset sizes for platforms such as Douyin, Kuaishou, Xiaohongshu, Facebook, Google, and TikTok. > > Three layout modes are supported: > > * **Original Image Layout** > * **AI Smart Layout** > * **Custom Layout** > > Multiple output sizes can be generated in a single request. #### Important Notes > * **Request rate:** Not specified. > * **Usage limits:** See the tool-specific limitations below. #### MCP Tools | **Tool** | **Description** | | --------------------------------------- | ------------------------------------------------------------------------ | | `submit_ai_ad_creative_batch_image` | Submit a batch image generation task with one or more target sizes. | | `get_ai_ad_creative_batch_image_detail` | Query the status and generated results of a batch image generation task. | ### `submit_ai_ad_creative_batch_image` Submits an AI ad creative batch image generation task. Upload product images and specify one or more target sizes to generate multiple ad creative formats. #### Parameters | **Parameter** | **Required** | **Type** | **Description** | | ------------------- | ------------ | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fileUrlList` | Yes | `FileUrlReq[]` | Product images. `fileName` is used as the basis for naming generated output files. Meaningful file names are recommended. | | `imageSizeList` | Yes | `AiBatchImageSizeReq[]` | Target output sizes. Supports **1–9 items**. Each item must exactly match a size combination listed in the size tables below. Custom size combinations are not allowed. | | `layout` | No | int | `1` = Original Image Layout / `2` = AI Smart Layout / `3` = Custom Layout | | `referenceFileList` | No | `FileUrlReq[]` | Reference images for the custom layout. Required only when `layout=3`. | | `dpi` | No | string | `1k` / `2k` / `4k`. Pixel dimensions must exactly match the selected resolution tier in the size tables below. | #### File Object: `FileUrlReq` | **Field** | **Description** | | ------------------ | ------------------------------------------------------------------ | | `fileSource` | `1` = KreadoAI File Library / `2` = Third-Party URL / `3` = Base64 | | `fileId` | Required when `fileSource=1`. | | `fileUrl` | Required when `fileSource=2` or `3`. | | `fileName` | Recommended. Used as the basis for naming generated output files. | | `thumbnailFileUrl` | Optional. | #### Size Object: `AiBatchImageSizeReq` All three fields are required for each item. The `width` and `height` values must **exactly match** the size table for the selected `dpi`. ```json { "width": 2432, "height": 380, "sizeRatio": "32:5" } ``` #### Example Requests **Product Image from the File Library** Generate an ultra-wide landscape image and a wide landscape image at `1k` resolution using the Original Image Layout: ```json { "fileUrlList": [ { "fileSource": 1, "fileId": 123456, "fileName": "product-main.png" } ], "dpi": "1k", "layout": 1, "imageSizeList": [ { "width": 2432, "height": 380, "sizeRatio": "32:5" }, { "width": 1940, "height": 500, "sizeRatio": "97:25" } ] } ``` **Product Image from a Third-Party URL with a Custom Layout Reference** ```json { "fileUrlList": [ { "fileSource": 2, "fileUrl": "https://cdn.example.com/product.jpg", "fileName": "product.jpg" } ], "dpi": "1k", "layout": 3, "referenceFileList": [ { "fileSource": 2, "fileUrl": "https://cdn.example.com/layout-ref.jpg", "fileName": "layout-ref.jpg" } ], "imageSizeList": [ { "width": 1200, "height": 1200, "sizeRatio": "1:1" }, { "width": 1080, "height": 1920, "sizeRatio": "9:16" } ] } ``` #### Important Notes * **Maximum 9 output sizes per request.** Requests containing more than 9 sizes are rejected by the frontend and server. * **Do not calculate pixel dimensions by scaling the aspect ratio.** The dimensions for the same `sizeRatio` are not always simple multiples across `1k`, `2k`, and `4k`. For example, `9:16` is `1080 × 1920` at `1k` and `1440 × 2560` at `2k`. Always use the exact dimensions listed in the corresponding size table. * **`dpi` and `imageSizeList` must use the same resolution tier.** For example, when `dpi` is `2k`, you cannot submit the `1k` dimensions `1200 × 1200`. * When `layout=3`, `referenceFileList` is required. It is not required for `layout=1` or `layout=2`. * Do not include `createUserId`, `requestSource`, or `taskId` when submitting a task. #### Size Tables **Important:** The `width` and `height` values must be copied exactly from the corresponding resolution table. Do not calculate or modify them manually. **1K**
sizeRatioNamewidthheight
1:1Square12001200
4:5Portrait12001500
5:4Landscape15001200
9:16Portrait10801920
16:9Landscape19201080
1.91:1Landscape1200628
4:3Landscape1024768
3:4Portrait7681024
3:2Landscape1200800
2:3Portrait8001200
2:1Ultra-wide Landscape1200600
1:2Portrait6321264
6:5Near-square12001000
1:8Extra-tall Portrait3522928
8:1Ultra-wide Landscape2928352
1:4Tall Portrait5122064
4:1Wide Landscape2064512
4:15Tall Portrait5121920
32:5Ultra-wide Landscape2432380
97:25Wide Landscape1940500
21:9Ultra-wide Landscape1568672
364:45Ultra-wide Landscape2912360
**2K**
sizeRatiowidthheight
1:120482048
4:518002250
5:422501800
9:1614402560
16:925601440
1.91:120481072
4:319201440
3:414401920
3:224001600
2:316002400
2:124001200
1:212642528
6:518001500
1:87045856
8:15856704
1:410244128
4:141281024
4:1510243840
32:54864760
97:2538801000
21:931361344
364:455824720
**4k**
sizeRatiowidthheight
1:140964096
4:536004500
5:445003600
9:1621603840
16:938402160
1.91:140962144
4:338402880
3:428803840
3:240002667
2:326674000
2:140002000
1:225285056
6:538403200
1:8140811712
8:1117121408
1:420488256
4:182562048
4:1520487680
32:597281520
97:2577602000
21:962722688
364:45116481440
### `get_ai_ad_creative_batch_image_detail` Retrieves the execution details and generated results of an AI ad creative batch image generation task. Use the task ID returned by `submit_ai_ad_creative_batch_image` to query the task status and generated assets. #### Response The response includes:
Field / InformationDescription
statusTask status: 1 = Pending, 2 = Processing, 3 = Success, 4 = Failed.
Subtask listA list of subtasks corresponding to each product image.
Generated file URLURL of each generated image.
Generated thumbnail URLThumbnail URL for each generated image.
DimensionsWidth and height of each generated image.
Model informationThe model/source used to generate each asset.
When the task succeeds, the response contains the generated image files and their corresponding metadata. ## 5. Website Data Crawling (For AI Ad Generation) ### Use Cases Crawl and analyze: * Brand websites * Landing pages * E-commerce product pages AI extracts structured product and brand information for downstream AI content generation. Processing time: **Typically 1–5 minutes** ### Important Notes * Recommended polling interval: 10–15 seconds * Maximum waiting time: 15 minutes * Result TTL: 24 hours * During polling, set: ``` includeContent=false ``` After task completion: ``` includeContent=true ``` Business source: | Value | Description | | ----- | ---------------------------- | | 1 | AI Marketing Video (Default) | | 2 | AI Advertising Image | ### MCP Tools #### 5.1 submit\_crawl\_task Submits a webpage crawling task. **Parameters** | Parameter | Required | Description | | --------- | -------- | ------------------ | | query | Yes | Target webpage URL | | source | No | Business source | | sessionId | No | Session identifier | Returns: ``` threadId ``` #### 5.2 get\_crawl\_task\_status Retrieves task status and crawling results. **Parameters** | Parameter | Required | | -------------- | -------- | | threadId | Yes | | includeContent | No | **Status** | Value | Description | | ---------- | ------------------- | | RUNNING | Processing | | SUCCESS | Completed | | FAILED | Failed | | NOT\_FOUND | Not Found / Expired | **Response Fields** * threadId * sessionId * status * currentNode * crawlId * url * source * errorMsg * content **Content Fields** * title * productName * brandName * price * currency * productDescription * productFeatures * targetAudience * useScenario * imageUrls * videoUrls * logoUrl * language * location * productLllmResult * metaDescription * content ## 6. AI Advertising Image Generation ### Use Cases Generate marketing images directly from: * Product URLs * Product content Supported modes: | Mode | Description | | ---------------- | ------------------------- | | generationMode=1 | AI Creative Generation | | generationMode=2 | Template-Based Generation | Customizable: * Prompt * Aspect ratio * Resolution * Logo * Brand color ### MCP Tools #### 6.1 submit\_url2image\_task Creates AI advertising image generation tasks. Returns: ``` mainTaskId ``` #### 6.2 get\_ai\_ad\_creative\_batch\_image\_detail Retrieves task execution results and generated image URLs. ## 7. Text-to-Speech (TTS) ### Use Cases Convert text into MP3 audio for: * Digital human videos * Advertising assets * Marketing campaigns Recommended workflow: ``` get_voice_language_list→ get_voice_list→ text_to_speech ``` ### Important Notes * Maximum 1 request per second * Valid apiToken required * voiceSource is required when voiceClone=0 ### MCP Tools #### 7.1 get\_voice\_language\_list Returns supported languages. Response: ``` List ``` #### 7.2 get\_voice\_list Returns voice models matching specified filters. Supported providers: | Value | Provider | | ----- | ---------- | | 1 | Microsoft | | 3 | Alibaba | | 4 | ByteDance | | 5 | MiniMax | | 6 | Google | | 21 | ElevenLabs | Response: ``` PageVo ``` #### 8.2 submit\_system\_lip\_task Creates a lip-sync generation task. Returns: ``` LipTaskResponseV3 ``` Contains: ``` jobId ``` #### 8.3 get\_lip\_video\_result Retrieves lip-sync generation results. Status: | Value | Description | | ----- | ----------- | | 1 | Pending | | 2 | Processing | | 3 | Completed | | 4 | Failed | | 5 | Timeout | Response: ``` LipVideoResultResponseV3 ``` ## 9. AI Video Generation (Image-to-Video / Text-to-Video) ### Use Cases Generate marketing videos using: * Text prompts * Images * Multi-image references * Multimodal references * Video continuation Supported model families: * Doubao Seedance Series * Veo * Sora * Vidu * Kling * Happy Horse * Wan * MiniMax ### Workflow ``` submit_image_to_video_task→ batch_get_image_to_video_detail ``` ### MCP Tools #### 9.1 submit\_image\_to\_video\_task Creates image-to-video or text-to-video generation tasks. Returns: ``` VideoGenerationResponseV3 ``` Includes: * taskId * taskIds #### Supported Reference Modes * none * first-last * reference * multimodal-reference * video-continuation #### Supported Media Types * image * video * audio #### 9.2 batch\_get\_image\_to\_video\_detail Retrieves generation results. Status: | Value | Description | | ----- | -------------------- | | 1 | Pending / Processing | | 2 | Success | | 3 | Failed | | 4 | Failed | Response: ``` List ``` ## 10. Subtitle & Watermark Removal ### Use Cases Remove: * Video subtitles * Watermarks Required inputs: * Source video URL * Subtitle coordinates * Watermark coordinates ### MCP Tools #### 10.1 submit\_subtitle\_removal\_task Creates a subtitle or watermark removal task. Returns: ``` jobId ``` #### 10.2 get\_subtitle\_removal\_result Retrieves task results. Status: | Value | Description | | ----- | ----------- | | 1 | Pending | | 2 | Processing | | 3 | Completed | | 4 | Failed | | 5 | Timeout | Returns: ``` targetVideoUrl ``` ## 11. Smart Canvas This chapter covers the KreadoAI Smart Canvas MCP tools. It starts with the basic tools for managing projects and querying tasks, then introduces task-specific submission tools. **Background removal is the only supported task in this release.** #### Use Cases > KreadoAI Smart Canvas allows you to submit image processing tasks to the current user's canvas project and returns a `batchId` and `taskIds`. > > Projects can be created or listed using the basic tools. For task submission, `projectId` can also be omitted. In that case, the service automatically creates a project named using the current time in the `yyyyMMdd-HHmmss` format (Asia/Shanghai). > > The only supported task in this release is background removal. > > Task submission is asynchronous and does not wait for completion. You must call `mcp_query_canvas_task_results` to poll the task status until it reaches a terminal state. #### Important Notes > * **Authentication:** Authentication relies on the currently logged-in user. If the user is not logged in, the request is rejected and the canvas service is not called. > * **Public Tool names:** All four tools use the `mcp_*` naming convention. > * **Projects:** `mcp_create_canvas_project` and `mcp_list_canvas_projects` are shared across all task types. For background removal, `projectId` can be omitted to automatically create a project. If a non-empty but invalid or unauthorized `projectId` is provided, the request returns an error instead of creating a new project. > * **Reuse existing projects (recommended):** If a reusable project is available—for example, a `projectId` returned by a previous submission or a project listed by `mcp_list_canvas_projects`—pass that `projectId` directly when submitting a task. Do not call `mcp_create_canvas_project` again, as each call creates a new project. > * **Polling (required):** After any successful task submission, call `mcp_query_canvas_task_results`. Continue polling when `status` is `0`, `1`, or `2`. When `status` is `3`, read the result URL. When `status` is `4` or `5`, read `errorMsg`. Stop polling once a terminal status is reached. #### Overview **Choose the Right Tool** | **Your goal** | **Tool** | **Notes** | | ------------------------------------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | Create a canvas project | `mcp_create_canvas_project` | Shared across all task types | | List existing projects and retrieve a valid `projectId` | `mcp_list_canvas_projects` | Shared across all task types | | Query task progress and results | `mcp_query_canvas_task_results` | Shared across all submitted tasks | | Batch background removal | `mcp_image_remove_bg` | Available in this release. Poll for results after submission. Results are typically available within 3–5 seconds. | **Tool Reference (4 Tools)** | # | **Tool** | **Category** | **Description** | | - | ------------------------------- | ------------------------ | ---------------------------------------------------------------------- | | 1 | `mcp_create_canvas_project` | Basic | Create a canvas project for the current user | | 2 | `mcp_list_canvas_projects` | Basic | List non-deleted canvas projects for the current user, with pagination | | 3 | `mcp_query_canvas_task_results` | Basic | Query task details by `batchId` and/or `taskIds` | | 4 | `mcp_image_remove_bg` | Task: Background Removal | Remove backgrounds from multiple images | ### Basic Tools #### 1. `mcp_create_canvas_project` Creates a Smart Canvas project for the current user. **Parameters** | **Parameter** | **Required** | **Description** | | ------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | No | Project name. After trimming, the name must not exceed 100 characters. If the name exceeds this limit, the server rejects the request without truncating it. If omitted or blank, the service uses the current time in the `yyyyMMdd-HHmmss` format (Asia/Shanghai), for example, `20260909-135152`. | **Response** | **Field** | **Description** | | --------- | --------------------------------------------------------------------------------------------------------- | | `id` | ID of the newly created project. Use this value as `projectId` in subsequent task submission calls. | | `name` | The name saved for the project: either the specified name or the automatically generated time-based name. | **Example Request** ```json { "name": "My Background Removal Project" } ``` #### 2. `mcp_list_canvas_projects` Lists all non-deleted Smart Canvas projects belonging to the current user. Use this tool to retrieve a valid `projectId`. **Parameters** | **Parameter** | **Required** | **Description** | | ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------- | | `name` | No | Fuzzy filter by project name. If omitted, all projects are listed. | | `current` | No | Page number. Defaults to `1`. Values less than `1` are treated as `1`. | | `size` | No | Number of items per page. Defaults to `50`. Values less than `1` are treated as `50`; values greater than `100` are treated as `100`. | **Response** | **Field** | **Description** | | --------- | ---------------------------------- | | `total` | Total number of matching projects. | | `current` | Actual page number returned. | | `size` | Actual page size returned. | | `items` | List of projects. | **`items[]` Fields** | **Field** | **Description** | | ------------ | ------------------------------------------------------------------------- | | `id` | Project ID. | | `name` | Project name. | | `createTime` | Creation time, returned when available. Format: `yyyy-MM-dd HH:mm:ss`. | | `updateTime` | Last update time, returned when available. Format: `yyyy-MM-dd HH:mm:ss`. | **Example Request** ```json { "name": "Background Removal", "current": 1, "size": 50 } ``` #### 3. `mcp_query_canvas_task_results` Queries task details for the current user by `batchId` and/or `taskIds`. At least one of `batchId` or `taskIds` must be provided. If both are empty, the canvas service is not called. **Parameters** | **Parameter** | **Required** | **Description** | | ------------- | ------------ | ------------------------------------------------------------------------------------------------ | | `batchId` | Conditional | Batch ID returned by a task submission. At least one of `batchId` or `taskIds` must be provided. | | `taskIds` | Conditional | List of task IDs. At least one of `batchId` or `taskIds` must be provided. | **Response** Returns an array of task details. Each item contains the following fields:
FieldDescription
taskIdTask ID.
batchIdBatch ID.
layerIdSystem-generated layer ID. Generally not needed by callers.
parentLayerIdParent layer ID. Generally not needed by callers.
taskTypeNumeric task type. Background removal is 5.
taskTypeValueString task type. Background removal is image_remove_bg.
resultTypeResult type: 1 = image, 2 = video, 3 = text. Background removal returns 1.
resultTypeValueResult type as a string. Background removal returns image.
statusTask status: 0 = Pending submission, 1 = Submitted, 2 = Processing, 3 = Success, 4 = Failed, 5 = Timed out. Statuses 3, 4, and 5 are terminal states. Stop polling when one of these states is reached.
errorMsgError details. Usually empty when the task succeeds.
resultFileIdID of the successfully generated result file. Can be used as fileId in subsequent submissions together with resultFileUrl.
resultFileUrlURL of the successfully generated result file.
resultThumbnailFileUrlURL of the result thumbnail.
innerResultDataExtended result data map. Contents depend on the task type. Callers generally do not need to parse this field.
**Example Request** ```json { "batchId": "batch-1" } ``` ### Background Removal Removes the background from one or more images. Supported inputs include a KreadoAI `fileId`, a KreadoAI file URL, an external URL, or image base64 data. If no `fileId` is provided, the image is uploaded to internal storage. > * `images` must contain at least 1 and at most 50 items. If any input asset fails validation or processing, the entire batch submission is rejected. > * When `fileId` is provided, the service resolves the file URL from the file library and does not re-upload the file. When only an HTTP(S) URL or base64 data is provided, the service uploads the image to internal storage. > * A project is created automatically only when `projectId` is omitted or blank. #### 4. `mcp_image_remove_bg` Submits a batch background removal task to Smart Canvas. A single image is also submitted as a batch containing one task. **Parameters** | **Parameter** | **Required** | **Description** | | ------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `projectId` | No | ID of an existing project. **Pass a reusable project ID whenever possible** to avoid creating a new project for every submission. If omitted or blank, the service automatically creates a project using the same naming rules as `mcp_create_canvas_project`, with a default name in the `yyyyMMdd-HHmmss` format. The response returns `projectCreated=true`. If a non-empty but invalid or unauthorized `projectId` is provided, the request returns an error instead of creating a new project. | | `images` | Yes | List of images to process. Must contain at least 1 and at most 50 items. See the table below for the item structure. | **`images[]` Fields** | **Field** | **Required** | **Description** | | ---------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fileId` | Conditional | ID of a file in the KreadoAI file library (`b_file.id`). When provided, the service resolves the URL from the file library and does not re-upload the file. | | `imageUrl` | Conditional | Image URL (`http`/`https`) or image base64 data. Required when `fileId` is not provided. Each item must contain at least one of `fileId` or `imageUrl`. External URLs and KreadoAI CDN URLs are uploaded to internal storage. | **Response**
FieldDescription
batchIdBatch ID used to poll task results.
taskIdsList of task IDs in the batch.
projectIdID of the project used for the submission.
projectCreatedWhether a new project was created for this submission: true or false.
taskTypeValueAlways image_remove_bg.
batchTotalNumber of tasks in the batch.
pollHintIndicates that mcp_query_canvas_task_results should be called to poll for results. This submission call does not wait for completion.
**Example Request (Mixing `fileId` and URL)** ```json { "projectId": "proj-1", "images": [ { "fileId": 15488077 }, { "imageUrl": "https://example.com/a.png" } ] } ``` **Example Request (URL Only)** ```json { "projectId": "proj-1", "images": [ { "imageUrl": "https://example.com/a.png" } ] } ``` ### Common Errors | **Issue** | **How to Handle It** | | ------------------------------------------------ | --------------------------------------------------------------------------------------------------- | | Both `fileId` and `imageUrl` are empty | Each item in `images` must contain at least one of these fields. | | File not found or unauthorized `fileId` | Use a file belonging to the current user, or provide an accessible URL instead. | | `images` is empty or contains more than 50 items | Provide between 1 and 50 images per request. | | Invalid `projectId` | Use a valid project ID belonging to the current user, or omit it to create a project automatically. | | `name` exceeds 100 characters | Shorten the project name. The server does not truncate it. | | Both `batchId` and `taskIds` are empty | Provide at least one of these fields. | | Canvas service unavailable | Retry later. Do not submit the same task again to avoid duplicate charges. | ## 12. Video Quality Enhancement #### Use Cases > KreadoAI Video Quality Enhancement improves the clarity and visual quality of input videos and returns a task ID. After successful submission, call `get_video_enhance_detail` to poll for the result. > > Input videos can be provided using a system file library `fileId` or a publicly accessible third-party URL. Third-party URLs are first uploaded to internal storage. Base64-encoded videos are not supported. > > Enhancement types: > > * `enhanceType`: `1` = Standard, `2` = AI Model > * `resolution`: `720p`, `1080p`, or `2k` (supported by both enhancement types) > * `fps`: Integer between `15` and `120`, inclusive. Common values include `24`, `30`, `45`, `60`, and `120`. > * `scene`: Only applicable to the Standard enhancement type. Defaults to `common` if omitted. Ignored for the AI Model enhancement type. > > Input videos must be between 3 seconds and 5 minutes long. #### Important Notes > * **Request rate limit:** You can submit a maximum of 1 task per second. #### MCP Tool Reference ### `submit_video_enhance_task` (Submit Task) Enhances the clarity and visual quality of an input video and returns a task ID. After submission, call `get_video_enhance_detail` to poll for the result. #### Parameters
ParameterRequiredDescription
videoYesInput video object. See the table below for its fields.
enhanceTypeYesEnhancement type: 1 = Standard, 2 = AI Model.
resolutionYesTarget resolution: 720p, 1080p, or 2k. Supported by both enhancement types. 4k is rejected.
fpsYesTarget frame rate. Must be an integer between 15 and 120, inclusive. Common values include 24, 30, 45, 60, and 120.
sceneNoScene type. Only applicable to the Standard enhancement type. Defaults to common if omitted. Ignored for the AI Model enhancement type.
batchIdNoBatch UUID. Use the same value when submitting multiple videos in one batch. If omitted, the server generates one.
#### `video` Object Fields | **Field** | **Required** | **Description** | | --------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fileId` | One of two | ID of a file in the system file library (`b_file.id`). If both `fileId` and `url` are provided, `fileId` takes precedence. | | `url` | One of two | Publicly accessible third-party video URL (`http` or `https`). The video is first uploaded to internal storage before submission. Base64-encoded videos are not supported. | #### Validation Rules The input video must be between 3 seconds and 5 minutes long. Requests that fall outside this range are rejected immediately and do not incur any charges. #### Response Returns: | **Field** | **Description** | | --------- | -------------------- | | `taskId` | Task ID as a string. | ### `get_video_enhance_detail` (Query Task Details) Retrieves the details and processing status of a video quality enhancement task. #### Parameters | **Parameter** | **Required** | **Description** | | ------------- | ------------ | ------------------------------------------------ | | `taskId` | Yes | Task ID returned by `submit_video_enhance_task`. | #### Response Fields
FieldDescription
id / batchIdTask ID / Batch identifier.
statusTask status: 1 = Pending, 2 = Processing, 3 = Success, 4 = Failed.
enhanceType / scene / resolution / fpsEchoes the submitted parameters.
sourceFileInput asset JSON, including fileId, internal URL, and thumbnail.
durationInput video duration in whole seconds. Used as the billing basis.
deductAmountActual amount deducted, in K-Coins.
resultFileResult asset JSON, including fileId, internal URL, dimensions, duration, and thumbnail. Populated when the task succeeds.
errorReason for failure.
createTime / updateTimeCreation and last update timestamps.
#### Access Restrictions You can only query your own tasks. Requests using another user's `taskId` are rejected. ## Contact Us Need technical support or want to learn more about KreadoAI MCP? 📧 Email: 🌐 Website: [www.kreadoai.com](http://www.kreadoai.com) Our team is always available to assist with your integration and deployment needs.