卡片
提交卡片生成任务需要认证¥0.01/次
POST
/cards/接口说明
⚠️ 注意:本接口目前仍在迭代开发中,暂时无法正常使用。请勿在生产环境中调用。
提交卡片生成任务到队列。任务在后台异步执行,生成完成后可通过任务 ID 查询结果。
主要用途:
- 根据模板 ID 和填充数据生成卡片图片
- 支持异步模式和同步等待模式
请求参数:
templateId:卡片模板 ID,指定使用哪个模板data:模板填充数据,键值对格式,用于替换模板中的变量
查询参数:
wait:可选,设为true时最多等待 5 秒返回结果,超时则返回 pending 状态
返回值:
taskId:任务唯一标识符,用于后续查询任务状态status:任务状态,pending表示处理中,completed表示已完成outputUrl:卡片图片的 CDN 地址,仅当 status 为completed时有值
调用流程:
- 提交任务,立即返回 taskId 和 pending 状态
- 后台 Worker 处理任务(渲染卡片、上传到 CDN)
- 轮询
GET /cards/:taskId查询任务状态 - 当 status 变为 completed 时,outputUrl 包含生成的卡片图片地址
授权说明:
- 需要提供有效的 API Key(Bearer Token)
- 每次调用会根据
unitPrice扣除相应费用 - 费用在任务提交时冻结,任务完成后确认扣除
请求头
参数类型必填说明
Authorizationstring是
从 Memene API 开放平台获取的 API Key。是 Bearer Token 格式,例如:Bearer sk_memene_xxx_yyy。可以 点击此处 获取 API KEY
请求参数
参数类型必填说明
wait
truefalse否是否同步等待完成(最多 5 秒)
templateIdstring是
模板 ID
dataobject是
模板填充数据
└[key: string]string是
请求示例
application/json
json
{
"templateId": "card_template_001",
"data": {
"title": "示例标题",
"content": "示例内容"
}
}响应结构
202application/json
Default Response
字段类型说明
taskIdstring
statusstring
outputUrlstring
示例
json
{
"taskId": "task_abc123",
"status": "pending",
"outputUrl": null
}