GET_TEXT_ANIMATIONS API Documentation #

🌐 Language Switch #

中文版 | English

Interface Information #

POST /openapi/capcut-mate/v1/get_text_animations

Function Description #

Get text entrance/exit animation list, returning all supported and qualified text entrance/exit animations. Support filtering based on animation type (entrance, exit, loop) and membership mode (all, VIP, free).

More Documentation #

📖 For more detailed documentation and tutorials, please visit: https://docs.jcaigc.cn

Request Parameters #

{
  "mode": 0,
  "type": "in"
}

Parameter Description #

Parameter Details #

Animation Mode Parameter #

• mode: Animation filtering mode
  • 0 = Return all animations (including VIP and free)
  • 1 = VIP animations only
  • 2 = Free animations only
  • Default: 0

Animation Type Parameter #

• type: Animation type, required parameter
  • "in" = Entrance animation (animation effect when text appears)
  • "out" = Exit animation (animation effect when text disappears)
  • "loop" = Loop animation (continuous loop animation effect while text plays)

Animation Mode Description #

Animation Type Description #

Response Format #

Success Response (200) #

{
  "effects": [
    {
      "resource_id": "7314291622525538843",
      "type": "in",
      "category_id": "ruchang",
      "category_name": "入场",
      "duration": 500000,
      "id": "35395178",
      "name": "冰雪飘动",
      "request_id": "",
      "start": 0,
      "icon_url": "https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/459c196951cadbd024456a63db89481f",
      "material_type": "sticker",
      "panel": "",
      "path": "",
      "platform": "all"
    },
    {
      "resource_id": "7397306443147252233",
      "type": "in",
      "category_id": "ruchang",
      "category_name": "入场",
      "duration": 500000,
      "id": "77035159",
      "name": "变色输入",
      "request_id": "",
      "start": 0,
      "icon_url": "https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/c15f5c313f8170c558043abf300a0692",
      "material_type": "sticker",
      "panel": "",
      "path": "",
      "platform": "all"
    }
  ]
}

Response Field Description #

Animation Object Structure #

Each animation object contains the following fields:

Error Response (4xx/5xx) #

{
  "detail": "Error message description"
}

Usage Examples #

cURL Examples #

1. Get All Entrance Animations #

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

2. Get VIP Exit Animations #

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

3. Get Free Loop Animations #

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

Error Code Description #

Notes #

1. Parameter Requirements: type parameter is required, mode parameter is optional
2. Animation Types: type parameter can only be one of "in", "out", "loop"
3. Animation Modes: mode parameter can only be one of 0, 1, 2
4. Response Format: Different from old version, current version directly returns object array instead of JSON string
5. Data Source: Currently using mock data, in production environment should get from database or API

Workflow #

1. Validate required parameter (type)
2. Validate parameter validity (type and mode)
3. Filter animation data based on type and mode
4. Return animation list meeting conditions

Related Interfaces #

• Add Captions
• Create Text Style
• Get Image Animations