墨刀AI API - 开放的原型设计
接口服务
强大的REST API,让原型设计与开发无缝连接
墨刀AI API提供了三个核心接口,让您能够通过简单的HTTP请求生成设计说明、创建HTML原型,并将HTML代码转换为墨刀工程文件。完美集成到您的开发工作流中。
核心特性
为开发者量身定制的API服务
RESTful API
标准的REST接口设计,支持JSON格式数据交互。简单易用的HTTP请求,让任何编程语言都能轻松集成。
安全认证
基于Token的安全认证机制,确保API调用的安全性。支持请求频率限制和访问权限控制。
高性能响应
毫秒级响应时间,支持高并发请求。采用先进的AI算法,快速生成高质量的设计内容和代码。
API 接口文档
三个核心接口,满足所有原型设计需求
基于用户输入生成详细的设计说明文档,包含功能描述、用户界面设计要求、交互流程等完整的产品设计规范。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user_input | string | 是 | 用户的设计需求描述 |
| reference | string | 否 | 可选的参考信息 |
{
"user_input": "设计一个电商网站的商品详情页",
"reference": "需要支持商品图片展示、规格选择和购买功能"
}
{
"description": "# 电商商品详情页设计说明\n\n## 页面目标\n提供完整的商品信息展示和购买流程..."
}
根据设计需求生成完整的HTML页面代码,包含现代化的CSS样式、响应式布局和交互效果。支持多种设计风格和组件库。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| user_input | string | 是 | 用户的设计需求描述 |
| reference | string | 否 | 可选的参考信息 |
{
"user_input": "创建一个现代化的登录页面,包含邮箱密码登录和社交登录",
"reference": "使用Material Design风格,主色调为蓝色"
}
{
"html": "完整的HTML代码内容",
"key": "用于导入的唯一标识符"
}
将HTML代码导入墨刀平台,自动解析并转换为可编辑的原型项目。支持复杂布局识别和组件自动分层。导入后的项目将默认保存到您的墨刀账号个人空间下。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | string | 二选一 | 从gen_html获取的key值(推荐方式,与htmlString任选其一) |
| htmlString | string | 二选一 | 完整的HTML代码字符串(与key任选其一) |
// 方式1: 使用key(推荐)
{
"key": "abc123def456"
}
// 方式2: 直接使用HTML字符串
{
"htmlString": "登录页面 ..."
}
{
"success": true,
"message": "导入成功消息",
"data": {
"projectId": "项目ID",
"name": "项目名称",
"url": "可访问的项目链接"
}
}
🔑 获取 API Token
开始使用API的第一步
登录墨刀平台,在个人设置中创建您的专属 API Token,用于所有API请求的身份验证。
访问墨刀官网
打开 modao.cc 或 modao.cc/ai 并登录您的账号
进入令牌设置
点击右上角的 头像菜单 → 选择 令牌设置
创建新Token
在令牌设置页面中,点击"生成新Token"按钮,复制并安全保存生成的Token
API 认证
安全简单的Token认证机制
准备您的Token
确保您已按照上方说明获取了有效的API Token。
💡 提示:如果还没有Token,请参考上方的"获取 API Token"部分
设置请求头
在所有API请求中添加Authorization头部,直接使用Token值。
Authorization: YOUR_TOKEN Content-Type: application/json
发送请求
使用标准的HTTP POST方法发送请求,确保请求体为有效的JSON格式。
curl -X POST https://modao.cc/aihtml-go/mcp/gen_html \
-H "Authorization: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"user_input": "创建登录页面"}'
代码示例
多种编程语言的完整示例
const response = await fetch('https://modao.cc/aihtml-go/mcp/gen_html', {
method: 'POST',
headers: {
'Authorization': 'YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({
user_input: '创建一个产品展示页面',
reference: '包含产品图片、价格、描述和购买按钮'
})
});
const result = await response.json();
console.log(result.html);
import requests
import json
url = 'https://modao.cc/aihtml-go/mcp/gen_description'
headers = {
'Authorization': 'YOUR_TOKEN',
'Content-Type': 'application/json'
}
data = {
'user_input': '电商购物车页面设计需求',
'reference': '支持商品数量修改、优惠券使用和结算功能'
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result['description'])
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://modao.cc/aihtml-go/mcp/import_html',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Authorization: YOUR_TOKEN',
'Content-Type: application/json'
],
CURLOPT_POSTFIELDS => json_encode([
'key' => $key_from_gen_html
])
]);
$response = curl_exec($curl);
$result = json_decode($response, true);
curl_close($curl);
# 生成HTML示例
curl -X POST https://modao.cc/aihtml-go/mcp/gen_html \
-H "Authorization: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"user_input": "现代化的用户注册页面",
"reference": "包含用户名、邮箱、密码输入框和注册按钮"
}'
# 导入HTML示例
curl -X POST https://modao.cc/aihtml-go/mcp/import_html \
-H "Authorization: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"key": "abc123def456"
}'
🔗 墨刀AI MCP 服务
Model Context Protocol - 更强大的AI集成方案
墨刀AI也提供MCP(Model Context Protocol)服务,让您的AI应用能够更深度地集成墨刀的设计能力,实现更智能的原型设计工作流。