> 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: <https://tally.so/r/mJOoeK>

#### 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

Upload a product image and generate multiple advertising creative sizes in a single task.

Supported platforms:

* Facebook
* Google
* TikTok
* Douyin
* Xiaohongshu
* Kuaishou

Layout modes:

* Original Layout
* AI Smart Layout
* Custom Layout

### MCP Tools

#### 4.1 submit\_ai\_ad\_creative\_batch\_image

Creates multiple advertising creatives from a single product image.

Returns:

* Task ID

#### 4.2 get\_ai\_ad\_creative\_batch\_image\_detail

Retrieves generation results.

Returns:

| Status | Description |
| ------ | ----------- |
| 1      | Pending     |
| 2      | Processing  |
| 3      | Completed   |
| 4      | Failed      |

Includes:

* Generated file URLs
* Thumbnail URLs
* Dimensions
* Model provider
* Child task list

## 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<VoiceLanguageResponseV3>
```

#### 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<VoiceInfoListResponseV3
```

#### 7.3 text\_to\_speech

Converts text into MP3 audio.

Returns:

* taskId
* audioUrl
* fileId
* duration
* paymentMoney

Response:

```
TextToSpeechResponseV3
```

***

## 8. Digital Human Video

### Use Cases

Generate lip-synced marketing videos using:

* Real-person avatars
* Photo avatars
* Cloned digital humans

Recommended workflow:

```
get_digital_human_avatar_list→ submit_system_lip_task→ get_lip_video_result
```

### MCP Tools

#### 8.1 get\_digital\_human\_avatar\_list

Returns available digital human avatars.

Response:

```
PageVo<DigitalHumanAvatarListResponseV3>
```

#### 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
* 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<VideoGenerationListResponseV3>
```

## 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
```

## Contact Us

Need technical support or want to learn more about KreadoAI MCP?

📧 Email: <support@kreadoai.com>

🌐 Website: [www.kreadoai.com](http://www.kreadoai.com)

Our team is always available to assist with your integration and deployment needs.
