Skip to content

IMGS_INFOS API Documentation ​

🌐 Language Switch ​

中文版 | English

Interface Information ​

POST /openapi/capcut-mate/v1/imgs_infos

Function Description ​

Generate image information based on image URLs and timelines. This interface converts image file URLs and timeline configurations into the image information format required by Jianying drafts, supporting animation effects and transition settings.

Request Parameters ​

json
{
  "imgs": ["https://assets.jcaigc.cn/img1.jpg", "https://assets.jcaigc.cn/img2.png"],
  "timelines": [
    {"start": 0, "end": 3000000},
    {"start": 3000000, "end": 6000000}
  ],
  "height": 1080,
  "width": 1920,
  "in_animation": "渐显",
  "in_animation_duration": 500000,
  "loop_animation": "动感摇晃I",
  "loop_animation_duration": 1000000,
  "out_animation": "渐隐",
  "out_animation_duration": 500000,
  "transition": "叠化",
  "transition_duration": 300000
}

Parameter Description ​

ParameterTypeRequiredDefaultDescription
imgsarray[string]✅-Image file URL array
timelinesarray[object]✅-Timeline configuration array
heightinteger❌NoneImage height
widthinteger❌NoneImage width
in_animationstring❌NoneIntro animation name; see add_images
in_animation_durationinteger❌NoneEntrance animation duration (microseconds)
loop_animationstring❌NoneLoop animation name; see add_images
loop_animation_durationinteger❌NoneLoop animation duration (microseconds)
out_animationstring❌NoneOutro animation name; see add_images
out_animation_durationinteger❌NoneExit animation duration (microseconds)
transitionstring❌NoneTransition name; see add_images / add_videos
transition_durationinteger❌NoneTransition duration (microseconds)

Available Transitions and Animations ​

For the full lists of valid transition / in_animation / out_animation / loop_animation values, see add_images → Supported Transitions and Animations.

Response Format ​

Success Response (200) ​

json
{
  "code": 0,
  "message": "success",
  "infos": "[{\"image_url\":\"https://assets.jcaigc.cn/img1.jpg\",\"start\":0,\"end\":3000000,\"height\":1080,\"width\":1920,\"in_animation\":\"渐显\",\"in_animation_duration\":500000,\"out_animation\":\"渐隐\",\"out_animation_duration\":500000,\"loop_animation\":\"动感摇晃I\",\"loop_animation_duration\":1000000,\"transition\":\"叠化\",\"transition_duration\":300000},{\"image_url\":\"https://assets.jcaigc.cn/img2.png\",\"start\":3000000,\"end\":6000000,\"height\":1080,\"width\":1920,\"in_animation\":\"渐显\",\"in_animation_duration\":500000,\"out_animation\":\"渐隐\",\"out_animation_duration\":500000,\"loop_animation\":\"动感摇晃I\",\"loop_animation_duration\":1000000,\"transition\":\"叠化\",\"transition_duration\":300000}]"
}

Response Field Description ​

FieldTypeDescription
infosstringImage information JSON string

Error Response ​

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

Usage Examples ​

cURL Examples ​

1. Basic Image Information Generation ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/imgs_infos \
  -H "Content-Type: application/json" \
  -d '{
    "imgs": ["https://assets.jcaigc.cn/cover.jpg"],
    "timelines": [{"start": 0, "end": 5000000}],
    "height": 1080,
    "width": 1920
  }'

2. Image Information with Animation Effects ​

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/imgs_infos \
  -H "Content-Type: application/json" \
  -d '{
    "imgs": ["https://assets.jcaigc.cn/slide1.jpg", "https://assets.jcaigc.cn/slide2.jpg"],
    "timelines": [{"start": 0, "end": 3000000}, {"start": 3000000, "end": 6000000}],
    "in_animation": "渐显",
    "loop_animation": "动感摇晃I",
    "out_animation": "渐隐",
    "transition": "叠化"
  }'

Error Code Description ​

Error CodeError MessageDescriptionSolution
1001Parameter validation failedRequest body failed schema validation (imgs/timelines missing, timeline item lacking start/end, or wrong types)Check parameter types and required fields

Notes ​

  1. Array Matching: if imgs 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. Resolution Settings: height and width parameters are used to set image display resolution
  4. Animation Effects: Support entrance animation, loop animation, exit animation, and transition effects
  5. Network Access: Image URLs must be accessible
  6. Format Support: Support common image formats (JPG, PNG, GIF, etc.)

Workflow ​

  1. Validate required parameters (imgs, timelines)
  2. Align the two arrays by the shorter length
  3. Validate timeline parameter validity
  4. Set image resolution parameters
  5. Apply animation effect parameters
  6. Generate corresponding image information for each image URL
  7. Convert information to JSON string format
  8. Return processing result

Language Switch ​

中文版 | English