EFFECT_INFOS API Documentation

🌐 Language Switch

中文版 | English

Interface Information

POST /openapi/capcut-mate/v1/effect_infos

Function Description

Generate effect information based on effect names and timelines. This interface converts effect names and timeline configurations into the effect information format required by Jianying drafts.

Request Parameters

{
  "effects": ["blur", "vignette"],
  "timelines": [
    {"start": 0, "end": 3000000},
    {"start": 3000000, "end": 6000000}
  ]
}

Parameter Description

Parameter	Type	Required	Default	Description
effects	array[string]	✅	-	Effect name array
timelines	array[object]	✅	-	Timeline configuration array

Response Format

Success Response (200)

{
  "code": 0,
  "message": "success",
  "infos": "[{\"effect_title\":\"blur\",\"start\":0,\"end\":3000000},{\"effect_title\":\"vignette\",\"start\":3000000,\"end\":6000000}]"
}

Response Field Description

Field	Type	Description
infos	string	Effect information JSON string

Error Response

{
  "code": 1001,
  "message": "Parameter validation failed"
}

Usage Examples

cURL Examples

1. Basic Effect Information Generation

curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/effect_infos \
  -H "Content-Type: application/json" \
  -d '{
    "effects": ["blur"],
    "timelines": [{"start": 0, "end": 5000000}]
  }'

2. Multiple Effect Information Generation

curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/effect_infos \
  -H "Content-Type: application/json" \
  -d '{
    "effects": ["blur", "vignette", "sepia"],
    "timelines": [{"start": 0, "end": 2000000}, {"start": 2000000, "end": 4000000}, {"start": 4000000, "end": 6000000}]
  }'

Error Code Description

Error Code	Error Message	Description	Solution
1001	Parameter validation failed	Request body failed schema validation (effects/timelines missing, timeline item lacking start/end, or wrong types)	Check parameter types and required fields

Notes

1. Array Matching: if effects and timelines lengths differ, the shorter length is used (no hard error)
2. Time Unit: All time parameters use microseconds (1 second = 1,000,000 microseconds)
3. Effect Names: Need to use system-supported effect names
4. Continuity: Effects are applied in timeline order

Workflow

1. Validate required parameters (effects, timelines)
2. Align the two arrays by the shorter length
3. Validate timeline parameter validity
4. Generate corresponding effect information for each effect name
5. Convert information to JSON string format
6. Return processing result

Related Interfaces

• Create Draft
• Add Effects
• Timelines
• Save Draft

---

📚 Project Resources
GitHub: https://github.com/Hommy-master/capcut-mate
Gitee: https://gitee.com/taohongmin-gitee/capcut-mate

Language Switch

中文版 | English