简创AIGC官方文档

主题切换

GET_TEXT_EFFECTS API 接口文档 ​

🌐 语言切换 ​

中文版 | English

接口信息 ​

bash
POST /openapi/capcut-mate/v1/get_text_effects

功能描述 ​

获取所有支持的花字效果列表，支持按 VIP/免费进行筛选。本接口参考滤镜列表接口的实现模式，提供 RESTful 风格的 POST 请求方式。

请求参数 ​

json
{
  "mode": 0
}

参数说明 ​

参数名类型必填默认值说明
modeinteger❌0花字效果模式：0=所有，1=VIP，2=免费

参数详解 ​

花字效果模式 ​

模式值模式名称说明
0所有返回所有花字效果（包括 VIP 和免费）
1VIP仅返回 VIP 花字效果
2免费仅返回免费花字效果

响应格式 ​

成功响应 (200) ​

json
{
  "code": 0,
  "message": "success",
  "text_effects": [
    {
      "id": "7539407429763796249",
      "title": "红黄火焰综艺花字",
      "is_vip": true
    },
    {
      "id": "7351316503771368713",
      "title": "综艺-黑暗斑驳红色",
      "is_vip": true
    }
  ]
}

响应字段说明 ​

字段名类型说明
text_effectsarray花字效果对象数组

TextEffectItem 对象 ​

字段名类型说明
idstring花字效果 ID
titlestring花字效果名称
is_vipboolean是否为 VIP 效果

错误响应 ​

json
{
  "code": 1001,
  "message": "参数校验失败"
}

使用示例 ​

cURL 示例 ​

1. 获取所有花字效果 ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_text_effects \
  -H "Content-Type: application/json" \
  -d '{"mode": 0}'

2. 获取 VIP 花字效果 ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_text_effects \
  -H "Content-Type: application/json" \
  -d '{"mode": 1}'

3. 获取免费花字效果 ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_text_effects \
  -H "Content-Type: application/json" \
  -d '{"mode": 2}'

配合 add_captions 使用 ​

javascript
// 1. 先获取花字效果列表
const effectsResponse = await fetch('/openapi/capcut-mate/v1/get_text_effects', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ mode: 0 })
});
const effects = await effectsResponse.json();

// 2. 用户选择一个花字效果
const selectedEffect = effects.text_effects[0];

// 3. 在添加字幕时使用该花字
await fetch('/openapi/capcut-mate/v1/add_captions', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    draft_id: "your_draft_id",
    captions: [...],
    text_effect: selectedEffect.title  // 或 selectedEffect.id
  })
});

错误码说明 ​

错误码错误信息说明解决方案
1001参数校验失败mode 超出 0-2 范围（请求体未通过参数校验）使用 0、1 或 2 作为 mode 值
2040获取滤镜列表失败获取花字效果列表失败联系技术支持

注意事项 ​

  1. 参数要求：mode 参数为可选，默认值为 0
  2. 模式取值：mode 只能是 0、1、2 之一
  3. 性能考虑：花字效果数量较多，建议客户端使用缓存机制
  4. 兼容性：即使没有 VIP 效果，接口也会正常返回空数组，不会报错
  5. 标识解析：可通过名称或 ID 在 add_captions 中引用花字效果

相关接口 ​

版权所有 © 2025 简创AIGC