Files
capcut-mate/openapi.yaml
T
2026-01-17 09:58:26 +08:00

2228 lines
108 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
components:
examples:
add_audios:
value:
ReqExample:
audio_infos: '[{"audio_url":"https://www.jcaigc.cn/output/upload/2025-10-27-23/20251027234830.mp3","duration":23184000,"end":23184000,"start":0}]'
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
RespExample:
audio_ids:
- 9000bc9efb744c3196fb1d225993f43d
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
track_id: a2d21e5a343c4f1eba3c9234bea16658
add_captions:
value:
ReqExample:
alignment: 1
alpha: 1
bold: false
captions: '[{"start":0,"end":10000000,"text":"你好,剪映","keyword":"好","keyword_color":"#457616","keyword_font_size":15}]'
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251216104033617e9734
font_size: 15
has_shadow: false
italic: false
letter_spacing: 0
line_spacing: 0
scale_x: 1
scale_y: 1
style_text: 0
text_color: '#ffffff'
transform_x: 0
transform_y: 0
underline: false
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251216104033617e9734
segment_ids:
- 1b1102e3d2d14b9eabac064bbe64d2bf
segment_infos:
- end: 10000000
id: 1b1102e3d2d14b9eabac064bbe64d2bf
start: 0
text_ids:
- 52ae035e01584adf8d052533d83948ed
track_id: 7ffdf0f7d67e4d8caff5531f5873d26f
add_effects:
value:
ReqExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262337379d98b90e
effect_infos: '[{"effect_title": "录制边框 III","start": 0,"end": 5000000}]'
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262337379d98b90e
effect_ids:
- 34c70fba3619444fa897110b40b39386
segment_ids:
- 23e0c0900c69427f82e44243183706c9
track_id: 2ffea3839d304f83ae29dadc43a18227
add_images:
value:
ReqExample:
alpha: 1
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
image_infos: '[{"image_url":"https://assets.jcaigc.cn/demo.png","width":1920,"height":1080,"start":0,"end":5000000,"duration":5000000,"animation":"淡入淡出","transition":"溶解","transition_duration":500000}]'
scale_x: 1
scale_y: 1
transform_x: 0
transform_y: 0
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
image_ids:
- fa67760440104ca3adacdfd694fc25da
segment_ids:
- 2d19f38d5f544eecad18847e5eac1745
segment_infos:
- end: 5000000
id: 2d19f38d5f544eecad18847e5eac1745
start: 0
track_id: 38c8dfee92374137998715329494a8f9
add_keyframes:
value:
ReqExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251210224255e23f7146
keyframes: '[{"segment_id":"e1933f126437421bb52abdc56f062266","property":"KFTypePositionX","offset":0.5,"value":-0.1}]'
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251210224255e23f7146
add_masks:
value:
ReqExample:
draft_url: 线性
name: 线性
segment_ids:
- beb4adbea83d41d08021cf4e8f219206
RespExample: {}
add_sticker:
value:
ReqExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262337379d98b90e
end: 5000000
scale: 1
start: 0
sticker_id: "7326810673609018675"
transform_x: 0
transform_y: 0
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262337379d98b90e
duration: 5000000
segment_id: 7902e009fcfb44768f6f73e9432b5d5b
sticker_id: "7326810673609018675"
track_id: 10b612824bcd4dd882ab764d145dd7ce
add_text_style:
value:
ReqExample:
font_size: 15
keyword: 五个快乐到死的顶级思维
keyword_color: '#ff7100'
keyword_font_size: 15
text: 快乐|顶级思维
RespExample:
text_style: '{"text":"快乐|顶级思维","styles":[{"fill":{"content":{"solid":{"color":[1.0,1.0,1.0]}}},"range":[0,7],"size":15,"font":{"id":"","path":""}}]}'
add_videos:
value:
ReqExample:
alpha: 1
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
scale_x: 1
scale_y: 1
scene_timelines: []
transform_x: 0
transform_y: 0
video_infos: '[{"video_url": "https://assets.jcaigc.cn/min.mp4","width": 1920,"height": 1080,"start": 0,"end": 3000000,"duration": 6000000,"mask": "","transition": "","transition_duration": 500000,"volume": 1}]'
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262111301f5fceff
segment_ids:
- 20285056b4194e2c8944b587ceb592a7
track_id: 720274203a11442280b64570caf362c4
video_ids:
- 9b9f47126f384a6f95434cdc3fed5b7c
audio_infos:
value:
ReqExample:
mp3_urls:
- https://assets.jcaigc.cn/test1.mp3
- https://assets.jcaigc.cn/test2.mp3
timelines:
- end: 284891428
start: 0
- end: 579578774
start: 284891428
RespExample:
infos: '[{"audio_url": "https://assets.jcaigc.cn/test1.mp3", "start": 0, "end": 284891428}, {"audio_url": "https://assets.jcaigc.cn/test2.mp3", "start": 284891428, "end": 579578774}]'
audio_timelines:
value:
ReqExample:
links:
- https://assets.jcaigc.cn/test1.mp3
- https://assets.jcaigc.cn/test2.mp3
RespExample:
all_timelines:
- end: 579578776
start: 0
timelines:
- end: 284891429
start: 0
- end: 579578776
start: 284891429
caption_infos:
value:
ReqExample:
texts:
- 床前明月光
- 明天我发光
timelines:
- end: 284891428
start: 0
- end: 579578774
start: 284891428
RespExample:
infos: '[{"start": 0, "end": 284891428, "text": "床前明月光"}, {"start": 284891428, "end": 579578774, "text": "明天我发光"}]'
create_draft:
value:
ReqExample:
height: 1920
width: 1080
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251230140504254f511b
tip_url: ""
easy_create_material:
value:
ReqExample:
audio_url: https://assets.jcaigc.cn/test1.mp3
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262348074813d881
font_size: 15
img_url: https://assets.jcaigc.cn/demp.png
text: 简创AIGC官网:www.jcaigc.cn
text_color: '#ffffff'
text_transform_y: 0
video_url: https://assets.jcaigc.cn/min.mp4
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=202511262348074813d881
message: 成功
effect_infos:
value:
ReqExample:
effects:
- 红包来了
- 雪花
timelines:
- end: 284891428
start: 0
- end: 579578774
start: 284891428
RespExample:
infos: '[{"effect_title": "红包来了", "start": 0, "end": 284891428}, {"effect_title": "雪花", "start": 284891428, "end": 579578774}]'
get_audio_duration:
value:
ReqExample:
mp3_url: https://assets.jcaigc.cn/test1.mp3
RespExample:
duration: 284891429
message: 成功
get_image_animations:
value:
ReqExample:
mode: 0
type: in
RespExample:
effects:
- category_id: pic_ruchang
category_name: 图片入场
duration: 600000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/fade_in_pic_icon
id: "35395179"
material_type: sticker
name: 渐显出现
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7314291622525538844"
start: 0
type: in
- category_id: pic_ruchang
category_name: 图片入场
duration: 800000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/scale_in_pic_icon
id: "77035160"
material_type: sticker
name: 缩放入场
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7397306443147252234"
start: 0
type: in
- category_id: pic_ruchang
category_name: 图片入场
duration: 700000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/fly_in_pic_icon
id: "12345679"
material_type: sticker
name: 飞入效果
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7298765432109876544"
start: 0
type: in
- category_id: pic_ruchang
category_name: 图片入场
duration: 900000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/light_emerge_pic_icon
id: "98765432"
material_type: sticker
name: 光影浮现
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7456789012345678901"
start: 0
type: in
get_text_animations:
value:
ReqExample:
mode: 0
type: in
RespExample:
effects:
- category_id: ruchang
category_name: 入场
duration: 500000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/459c196951cadbd024456a63db89481f
id: "35395178"
material_type: sticker
name: 冰雪飘动
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7314291622525538843"
start: 0
type: in
- category_id: ruchang
category_name: 入场
duration: 500000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/c15f5c313f8170c558043abf300a0692
id: "77035159"
material_type: sticker
name: 变色输入
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7397306443147252233"
start: 0
type: in
- category_id: ruchang
category_name: 入场
duration: 750000
icon_url: https://lf5-hl-hw-effectcdn-tos.byteeffecttos.com/obj/ies.fe.effect/fade_in_icon
id: "12345678"
material_type: sticker
name: 渐显入场
panel: ""
path: ""
platform: all
request_id: ""
resource_id: "7298765432109876543"
start: 0
type: in
get_url:
value:
ReqExample:
output: 中国人https://assets.jcaigc.cn/test1.mp3
RespExample:
output: 中国人https://assets.jcaigc.cn/test1.mp3
imgs_infos:
value:
ReqExample:
height: 1024
imgs:
- https://assets.jcaigc.cn/demo.png
- https://assets.jcaigc.cn/demo1.png
timelines:
- end: 284891428
start: 0
- end: 579578774
start: 284891428
width: 1024
RespExample:
infos: '[{"image_url": "https://assets.jcaigc.cn/demo.png", "start": 0, "end": 284891428, "height": 1024, "width": 1024}, {"image_url": "https://assets.jcaigc.cn/demo1.png", "start": 284891428, "end": 579578774, "height": 1024, "width": 1024}]'
keyframes_infos:
value:
ReqExample:
ctype: KFTypePositionX
height: 1080
offsets: 0|100
segment_infos:
- end: 5000000
id: c1369c795ca64fe38bac1f2a93e8a811
start: 0
values: 1|2
width: 1920
RespExample:
keyframes_infos: '[{"offset": 0, "property": "KFTypePositionX", "segment_id": "c1369c795ca64fe38bac1f2a93e8a811", "value": 0.0005208333333333333}, {"offset": 5000000, "property": "KFTypePositionX", "segment_id": "c1369c795ca64fe38bac1f2a93e8a811", "value": 0.0010416666666666667}]'
objs_to_str_list:
value:
ReqExample:
outputs:
- output: https://assets.jcaigc.cn/max.mp4
- output: https://assets.jcaigc.cn/min.mp4
RespExample:
infos:
- https://assets.jcaigc.cn/max.mp4
- https://assets.jcaigc.cn/min.mp4
save_draft:
value:
ReqExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251126220753b7e35362
RespExample:
draft_url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=20251126220753b7e35362
message: 成功
search_sticker:
value:
ReqExample:
keyword:
RespExample:
data:
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/91ada02f8fec440798fbce5b6c8052f4~tplv-3jr8j4ixpe-image.image?x-expires=1797257777&x-signature=JGLXAdKzUC1SNFOG1DBIj7deSm0%3D
preview_cover: ""
sticker_package:
height_per_frame: 128
size: 2233
width_per_frame: 128
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/91ada02f8fec440798fbce5b6c8052f4~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=OlE4ZjEFzZ0%2BZE2hx984dtqX1JY%3D&format=.png
sticker_id: "7128787497496120613"
title: '人物剪影 '
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/dde1931edf4e4026b24b52bdf83cdcc0~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=C69yhUjUgvAfbKC%2B3lnqRj4d4Mo%3D
preview_cover: ""
sticker_package:
height_per_frame: 512
size: 34542
width_per_frame: 512
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/dde1931edf4e4026b24b52bdf83cdcc0~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=4zY6CNDljdwTfxWGCcNdI7VX54U%3D&format=.png
sticker_id: "7075169384330726663"
title: 男性卡通手绘人物
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/edbd487bfbe347b49183ac297dece704~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=w%2FYtiqgjYd89ZRiBz0CmlhPaYWg%3D
preview_cover: ""
sticker_package:
height_per_frame: 452
size: 172903
width_per_frame: 256
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/edbd487bfbe347b49183ac297dece704~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=GAb5g%2B0hERhVIOqy9HG%2BGzvBR2E%3D&format=.png
sticker_id: "7141375321454021922"
title: 3d 人物
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/e42cb5d3d37146738d2b9b714c9a0ce3~tplv-3jr8j4ixpe-resize:1920:1920.gif?x-expires=1797257777&x-signature=5%2BKU1MAEkt4E6uRzqBiqpG6GPKw%3D
preview_cover: ""
sticker_package:
height_per_frame: 280
size: 122700
width_per_frame: 280
sticker_type: 2
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/e42cb5d3d37146738d2b9b714c9a0ce3~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=uF1QWPpgsM62Jc%2BgIpKFkH0PwwM%3D&format=.png
sticker_id: "7002854862090210590"
title: 人挤人
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/d05c664aceba49d2896660562ae5fe4d~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=dTV36p4iN055SxRvTcovbiq9QEs%3D
preview_cover: ""
sticker_package:
height_per_frame: 490
size: 126967
width_per_frame: 463
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/d05c664aceba49d2896660562ae5fe4d~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=jmY7LUydyEJr9vVpGFBPQFhYp7Y%3D&format=.png
sticker_id: "6989061706173500703"
title: 人物背影
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/adff9a9ac6b14db291eb1da1964b140f~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=ISDIKQ6grSn9cyZW0TFq%2BF86y5M%3D
preview_cover: ""
sticker_package:
height_per_frame: 419
size: 91220
width_per_frame: 540
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/adff9a9ac6b14db291eb1da1964b140f~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=OQokcDqdpZrfjbbJ5I2miMz9vF8%3D&format=.png
sticker_id: "6972844711287524621"
title: 商务人物工作会议人员扁平化职场 (28)
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/656e900a0bb6415db5199c58e8148b55~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797257777&x-signature=MLWZQjACxbpcUkQyznGMzpyHn9I%3D
preview_cover: ""
sticker_package:
height_per_frame: 512
size: 33884
width_per_frame: 512
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/656e900a0bb6415db5199c58e8148b55~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797257777&x-signature=
sticker_id: "6972844711287524622"
title: 商务人物工作会议人员扁平化职场 (29)
- sticker:
large_image:
image_url: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/4f77f60ad9924712baa4e32d534e342c~tplv-3jr8j4ixpe-resize:1920:1920.png?x-expires=1797258668&x-signature=Co7%2B81Xhn880nPNA7UBRlI2UPyE%3D
preview_cover: ""
sticker_package:
height_per_frame: 540
size: 104066
width_per_frame: 540
sticker_type: 1
track_thumbnail: https://p3-heycan-jy-sign.byteimg.com/tos-cn-i-3jr8j4ixpe/4f77f60ad9924712baa4e32d534e342c~tplv-3jr8j4ixpe-resize:120:120.png?x-expires=1797258668&x-signature=V7SlC36041lGmBHWsvY3lYgEuRk%3D&format=.png
sticker_id: "7243670138606718265"
title: 人气爆款标签
message: 成功
str_list_to_objs:
value:
ReqExample:
infos:
- https://assets.jcaigc.cn/min.mp4
- https://assets.jcaigc.cn/max.mp4
RespExample:
infos:
- output: https://assets.jcaigc.cn/min.mp4
- output: https://assets.jcaigc.cn/max.mp4
str_to_list:
value:
ReqExample:
obj: '{ "infos": [ "https://assets.jcaigc.cn/min.mp4", "https://assets.jcaigc.cn/max.mp4" ] }'
RespExample:
infos:
- '{ "infos": [ "https://assets.jcaigc.cn/min.mp4", "https://assets.jcaigc.cn/max.mp4" ] }'
timelines:
value:
ReqExample:
duration: 10000000
num: 2
start: 0
type: 0
RespExample:
all_timelines:
- end: 10000000
start: 0
timelines:
- end: 5000000
start: 0
- end: 10000000
start: 5000000
video_infos:
value:
ReqExample:
height: "1080"
mask: 爱心
timelines:
- end: 284891428
start: 0
- end: 579578774
start: 284891428
transition: 推近
transition_duration: 1
video_urls:
- https://assets.jcaigc.cn/min.mp4
- https://assets.jcaigc.cn/max.mp4
volume: 1
width: 1920
RespExample:
infos: '[{"video_url": "https://assets.jcaigc.cn/min.mp4", "start": 0, "end": 284891428, "duration": 284891428, "width": 1920, "height": 1080, "mask": "爱心", "transition": "推近", "transition_duration": 1, "volume": 1.0}, {"video_url": "https://assets.jcaigc.cn/max.mp4", "start": 284891428, "end": 579578774, "duration": 294687346, "width": 1920, "height": 1080, "mask": "爱心", "transition": "推近", "transition_duration": 1, "volume": 1.0}]'
info:
description: 剪映小助手一个开源且免费的剪映插件,兼容剪映V5.9及以上所有版本。
title: 开源剪映小助手
version: v1
openapi: 3.0.1
paths:
/add_audios:
post:
operationId: add_audios
requestBody:
content:
application/json:
schema:
properties:
audio_infos:
description: '音频信息,示例:[{"audio_url": "http://example.com/audio1.mp3","duration":120,"start":0,"end":12000000,"audio_effect":"教堂"}]'
type: string
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
required:
- draft_url
- audio_infos
type: object
responses:
"200":
content:
application/json:
schema:
properties:
audio_ids:
items:
type: string
type: array
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
x-global-disable: true
track_id:
type: string
type: object
description: new desc
default:
description: ""
summary: 批量添加音频
/add_captions:
post:
operationId: add_captions
requestBody:
content:
application/json:
schema:
properties:
alignment:
default: 1
description: 文本对齐方式(0-5
type: integer
alpha:
default: 1
description: 文本透明度(0.0-1.0
type: number
bold:
default: false
description: 文本加粗开关
type: boolean
border_color:
description: 边框颜色(十六进制)
type: string
captions:
description: JSON字符串格式的字幕信息数组
type: string
draft_url:
description: 剪映草稿URL
type: string
font:
description: 字体名称
type: string
font_size:
default: 15
description: 字体大小
type: integer
has_shadow:
default: false
description: '文本阴影开关(true为打开,false为关闭),如果打开了,但没有填shadow_info,默认就是{ "shadow_color": "#000000", "shadow_alpha": 0.9, "shadow_diffuse": 15, "shadow_distance": 5, "shadow_angle", -45 }'
type: boolean
italic:
default: false
description: 文本斜线开关(true为打开,false为关闭),默认关闭
type: boolean
letter_spacing:
default: 0
description: 字间距
type: number
line_spacing:
default: 0
description: 行间距
type: number
scale_x:
default: 1
description: 水平缩放
type: number
scale_y:
default: 1
description: 垂直缩放
type: number
shadow_info:
description: 文本阴影
properties:
shadow_alpha:
description: 阴影不透明度, 取值范围为[0, 1]
type: number
shadow_angle:
description: 阴影角度, 取值范围为[-180, 180]
type: number
shadow_color:
description: 阴影颜色(十六进制)
type: string
shadow_diffuse:
description: 阴影扩散程度, 取值范围为[0, 100]
type: number
shadow_distance:
description: 阴影距离, 取值范围为[0, 100]
type: number
type: object
style_text:
default: 0
description: 是否使用样式文本
type: integer
text_color:
default: '#ffffff'
description: 文本颜色(十六进制)
type: string
text_effect:
description: 文本花字
type: string
transform_x:
default: 0
description: 水平位移
type: number
transform_y:
default: 0
description: 垂直位移
type: number
underline:
default: false
description: 文本下划线开关(true为打开,false为关闭)
type: boolean
required:
- draft_url
- captions
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
x-global-disable: true
segment_ids:
items:
type: string
type: array
segment_infos:
items:
properties:
end:
type: number
id:
type: string
start:
type: number
type: object
type: array
text_ids:
items:
type: string
type: array
track_id:
type: string
type: object
description: new desc
default:
description: ""
summary: 批量添加字幕
/add_effects:
post:
operationId: add_effects
requestBody:
content:
application/json:
schema:
properties:
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
effect_infos:
description: 特效数组内容,eg:[{"effect_title":"金粉闪闪","end":5000000,"start":0}]
type: string
required:
- draft_url
- effect_infos
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
effect_ids:
items:
type: string
type: array
message:
type: string
x-global-disable: true
segment_ids:
items:
type: string
type: array
track_id:
type: string
type: object
description: new desc
default:
description: ""
summary: 添加特效
/add_images:
post:
operationId: add_images
requestBody:
content:
application/json:
schema:
properties:
alpha:
default: 1
description: 图片透明度,值0-1
type: number
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
image_infos:
description: "图片信息,示例:[ \t{ \t\t\"image_url\":\"https://assets.jcaigc.cn/demo.png\", // 图片URL \t\t\"width\":1920, // 宽 \t\t\"height\":1080, // 高 \t\t\"start\":0, // 开始时间,单位:毫秒 \t\t\"end\":5000000,// 结束时间,单位:毫秒 \t\t\"duration\":5000000, // 时长 \t\t\"animation\":\"淡入淡出\", // 动画 \t\t\"transition\":\"溶解\", // 转场 \t\t\"transition_duration\":500000 // 转场时间 \t} "
type: string
scale_x:
default: 1
description: x缩放
type: number
scale_y:
default: 1
description: y缩放
type: number
transform_x:
default: 0
description: 移动transform_x
type: number
transform_y:
default: 0
description: 移动transform_y
type: number
required:
- draft_url
- image_infos
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
image_ids:
items:
type: string
type: array
message:
type: string
x-global-disable: true
segment_ids:
items:
type: string
type: array
segment_infos:
items:
properties:
end:
type: number
id:
type: string
start:
type: number
type: object
type: array
track_id:
type: string
type: object
description: new desc
default:
description: ""
summary: 批量添加图片
/add_keyframes:
post:
operationId: add_keyframes
requestBody:
content:
application/json:
schema:
properties:
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
keyframes:
description: '关键帧数据,格式: [ { "offset": 5000000, "property": "KFTypePositionX", "segment_id": "acc5b516-046b-4eae-a179-f686f35e70a8", "value": 0 } ]'
type: string
required:
- draft_url
- keyframes
type: object
responses:
"200":
content:
application/json:
schema:
properties:
affected_segments:
items:
type: string
type: array
x-global-disable: true
code:
type: number
x-global-disable: true
draft_url:
type: string
keyframes_added:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 添加关键帧
/add_masks:
post:
operationId: add_masks
requestBody:
content:
application/json:
schema:
properties:
X:
description: 对应剪映的X位置
type: integer
"Y":
description: 对应剪映的Y位置
type: integer
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
feather:
description: 羽化0-100
type: integer
height:
description: 对应剪映的宽高
type: integer
invert:
description: 是否反转
type: boolean
name:
description: 蒙板类型:线性/镜面/圆形/矩形/爱心/星形
type: string
rotation:
description: 旋转角度0-360
type: integer
roundCorner:
description: 矩形的圆角
type: integer
segment_ids:
description: add_videos或者add_images的返回值
items:
description: 片段id
type: string
type: array
width:
description: 对应剪映的宽高
type: integer
required:
- draft_url
- segment_ids
- name
type: object
responses:
"200":
content:
application/json:
schema:
properties:
affected_segments:
items:
type: string
type: array
x-global-disable: true
code:
type: number
x-global-disable: true
draft_url:
type: string
mask_ids:
items:
type: string
type: array
x-global-disable: true
masks_added:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 增加蒙版
/add_sticker:
post:
operationId: add_sticker
requestBody:
content:
application/json:
schema:
properties:
draft_url:
description: 目标草稿的完整URL
type: string
end:
description: 贴纸结束时间(微秒)
type: integer
scale:
default: 1
description: 贴纸缩放比例
type: number
start:
description: 贴纸开始时间(微秒)
type: integer
sticker_id:
description: 贴纸的唯一标识ID
type: string
transform_x:
default: 0
description: X轴位置偏移(像素)
type: integer
transform_y:
default: 0
description: Y轴位置偏移(像素)
type: integer
required:
- draft_url
- end
- start
- sticker_id
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
duration:
type: number
message:
type: string
x-global-disable: true
segment_id:
type: string
sticker_id:
type: string
track_id:
type: string
type: object
description: new desc
default:
description: ""
summary: '添加贴纸,批处理时,并发要设置成1 '
/add_text_style:
post:
operationId: add_text_style
requestBody:
content:
application/json:
schema:
properties:
font_size:
default: 15
description: 普通文本的字体大小
type: integer
keyword:
description: 关键词,多个用 | 分隔
type: string
keyword_color:
default: '#ff7100'
description: 关键词文本颜色(十六进制)
type: string
keyword_font_size:
default: 15
description: 关键词字体大小
type: integer
text:
description: 要处理的文本内容
type: string
required:
- keyword
- text
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
text_style:
type: string
type: object
description: new desc
default:
description: ""
summary: 创建文本富文本样式
/add_videos:
post:
operationId: add_videos
requestBody:
content:
application/json:
schema:
properties:
alpha:
default: 1
description: 透明度:0-1 ,默认1
type: number
draft_url:
description: 草稿地址,使用create_draft输出的draft_url即可
type: string
scale_x:
default: 1
description: 剪映scale_x 缩放
type: number
scale_y:
default: 1
description: 剪映scale_y 缩放
type: number
scene_timelines:
description: '分镜时间线,自动变速,例如:[{start: 0, end: 6000000}]'
items:
description: 分镜时间线
properties:
curve_speed:
description: 曲线变速参数
type: string
end:
description: 结束时间线
type: integer
start:
description: 开始时间线
type: integer
type: object
type: array
transform_x:
default: 0
description: 剪映x位置
type: number
transform_y:
default: 0
description: 剪映y位置
type: number
video_infos:
description: '[ { "video_url": "https://example.com/video1.mp4", "duration": 12000000, // 视频时长,以秒*1000000为单位 "width": 1920, // 视频宽度 "height": 1080, // 视频高度 "start": 0, // 视频在时间轴上的开始时间 "end": 12000000 // 视频在时间轴上的结束时间 } ]'
type: string
required:
- draft_url
- video_infos
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
x-global-disable: true
segment_ids:
items:
type: string
type: array
track_id:
type: string
video_ids:
items:
type: string
type: array
type: object
description: new desc
default:
description: ""
summary: 批量添加视频
/audio_infos:
post:
operationId: audio_infos
requestBody:
content:
application/json:
schema:
properties:
audio_effect:
description: 特效音,eg:教堂,默认无
type: string
mp3_urls:
description: 音频列表
items:
description: 音频连接地址
type: string
type: array
timelines:
description: 时间线
items:
description: 时间线对象
properties:
end:
description: 结束时间
type: integer
start:
description: 开始时间
type: integer
required:
- start
- end
type: object
type: array
volume:
description: 音量大小,0-10,默认1
type: number
required:
- mp3_urls
- timelines
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 根据时间线制作音频数据
/audio_timelines:
post:
operationId: audio_timelines
requestBody:
content:
application/json:
schema:
properties:
links:
description: 音频链接列表
items:
description: 音频链接
type: string
type: array
required:
- links
type: object
responses:
"200":
content:
application/json:
schema:
properties:
all_timelines:
items:
properties:
end:
type: number
start:
type: number
type: object
type: array
code:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
timelines:
items:
properties:
end:
type: number
start:
type: number
type: object
type: array
type: object
description: new desc
default:
description: ""
summary: 从音频列表中获取时间线列表
/caption_infos:
post:
operationId: caption_infos
requestBody:
content:
application/json:
schema:
properties:
font_size:
description: 字体大小
type: integer
in_animation:
description: 入场动画名称
type: string
in_animation_duration:
description: 入场动画时长
type: integer
keyword_color:
description: 关键词颜色
type: string
keyword_font_size:
description: 关键词字大小
type: integer
keywords:
description: 文本里面的重点词列表
items:
description: 重点词
type: string
type: array
loop_animation:
description: 对应剪映的循环动画名字,多个动画请用英文|分割,比如:扫光|晃动
type: string
loop_animation_duration:
description: 循环动画时长
type: integer
out_animation:
description: 对应剪映的出场动画名字,多个动画请用英文|分割,比如:消散|闭幕
type: string
out_animation_duration:
description: 出场动画时长
type: integer
texts:
description: 文本列表
items:
description: 文本
type: string
type: array
timelines:
description: 时间节点,只接收结构:[{"start":0,"end":4612}],一般从audio_timeline节点的输出获取
items:
description: 时间线
properties:
end:
description: 结束时间
type: integer
start:
description: 开始时间
type: integer
required:
- start
- end
type: object
type: array
required:
- texts
- timelines
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 根据时间线制作字幕数据
/create_draft:
post:
operationId: create_draft
requestBody:
content:
application/json:
schema:
properties:
height:
default: 1920
description:
type: integer
width:
default: 1080
description:
type: integer
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
x-global-disable: true
tip_url:
type: string
type: object
description: new desc
default:
description: ""
summary: 插件入口-创建草稿
/easy_create_material:
post:
operationId: easy_create_material
requestBody:
content:
application/json:
schema:
properties:
audio_url:
description: 音频文件URL,不能为空或"null"
type: string
draft_url:
description: 目标草稿的完整URL
type: string
font_size:
default: 15
description: 字体大小
type: integer
img_url:
description: 图片文件URL
type: string
text:
description: 要添加的文字内容
type: string
text_color:
default: '#ffffff'
description: 文字颜色(十六进制格式)
type: string
text_transform_y:
default: 0
description: 文字Y轴位置偏移
type: integer
video_url:
description: 视频文件URL
type: string
required:
- audio_url
- draft_url
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
type: object
description: new desc
default:
description: ""
summary: |-
快速上手,简易创建素材轨道
create_draft+easy_create_material即可
/effect_infos:
post:
operationId: effect_infos
requestBody:
content:
application/json:
schema:
properties:
effects:
description: 特效名字列表
items:
description: 特效名
type: string
type: array
timelines:
description: 时间节点,只接收结构:[{"start":0,"end":4612}],一般从audio_timeline节点的输出获取
items:
description: 时间线
properties:
end:
description: 结束时间
type: integer
start:
description: 开始时间
type: integer
required:
- start
- end
type: object
type: array
required:
- effects
- timelines
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 根据时间线关联特效
/get_audio_duration:
post:
operationId: get_audio_duration
requestBody:
content:
application/json:
schema:
properties:
mp3_url:
description: 音频/视频文件URL
type: string
required:
- mp3_url
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
duration:
type: integer
message:
type: string
type: object
description: new desc
default:
description: ""
summary: 获取音频/视频文件时长
/get_image_animations:
post:
operationId: get_image_animations
requestBody:
content:
application/json:
schema:
properties:
mode:
default: 0
description: 默认0 全部 1 vip 2 免费
type: integer
type:
default: in
description: in:入场 ,out:出场,loop:组合
type: string
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
effects:
items:
properties:
category_id:
type: string
category_name:
type: string
duration:
type: number
icon_url:
type: string
id:
type: string
material_type:
type: string
name:
type: string
panel:
type: string
path:
type: string
platform:
type: string
request_id:
type: string
resource_id:
type: string
start:
type: number
type:
type: string
type: object
type: array
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 获取图片出入场动画
/get_text_animations:
post:
operationId: get_text_animations
requestBody:
content:
application/json:
schema:
properties:
mode:
default: 0
description: 0:所有,1VIP 2:免费
type: integer
type:
default: in
description: in:入场,out:出场,loop:循环
type: string
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
effects:
items:
properties:
category_id:
type: string
category_name:
type: string
duration:
type: number
icon_url:
type: string
id:
type: string
material_type:
type: string
name:
type: string
panel:
type: string
path:
type: string
platform:
type: string
request_id:
type: string
resource_id:
type: string
start:
type: number
type:
type: string
type: object
type: array
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 获取文字出入场动画
/get_url:
post:
operationId: get_url
requestBody:
content:
application/json:
schema:
properties:
output:
description: 提取内容
type: string
required:
- output
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
output:
type: string
type: object
description: new desc
default:
description: ""
summary: 提取链接,用于多值返回变成单值返回
/imgs_infos:
post:
operationId: imgs_infos
requestBody:
content:
application/json:
schema:
properties:
height:
default: 1024
description: 图片高
type: integer
imgs:
description: 图片列表
items:
description: 图片地址
type: string
type: array
in_animation:
description: 对应剪映的入场动画名字 可选,多个动画请用英文|分割,比如:动画1|动画2
type: string
in_animation_duration:
description: 对应剪映的入场动画时长 可选
type: integer
loop_animation:
description: 对应剪映的组合动画名字 可选,多个动画请用英文|分割,比如:动画1|动画2
type: string
loop_animation_duration:
description: ' 组合动画时长'
type: integer
out_animation:
description: 对应剪映的出场动画名字。可选,多个动画请用英文|分割,比如:动画1|动画2
type: string
out_animation_duration:
description: 对应剪映的出场动画时长 可选
type: integer
timelines:
description: 时间节点,只接收结构:[{"start":0,"end":4612}],一般从audio_timeline节点的输出获取
items:
description: 时间线
properties:
end:
description: 结束时间
type: integer
start:
description: 开始时间
type: integer
required:
- start
- end
type: object
type: array
transition:
description: 对应剪映的转场动画名字 可选
type: string
transition_duration:
description: 对应剪映的转场动画时长 ,范围是500000-2500000 可选
type: string
width:
default: 1024
description: 图片宽
type: integer
required:
- imgs
- timelines
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 根据时间线制作图片数据
/keyframes_infos:
post:
operationId: keyframes_infos
requestBody:
content:
application/json:
schema:
properties:
ctype:
description: '关键帧类型: KFTypePositionX: X轴移动,需要提供width参数,值会被除以width进行归一化 KFTypePositionY: Y轴移动,需要提供height参数,值会被除以height进行归一化 KFTypeRotation: 旋转角度,值范围必须在0-360度之间 UNIFORM_SCALE: 均匀缩放,值范围必须在0.01-5之间 KFTypeAlpha: 透明度,值范围必须在0-1之间'
type: string
height:
description: 视频高度
type: integer
offsets:
description: 需要放置关键帧的位置比例,eg:0|100 这个就是代表在开始和结尾放置,0|50|100代表在开头,中间,结尾放置3个关键帧
type: string
segment_infos:
description: 轨道数据,add_images节点输出
items:
description: 轨道数据
properties:
end:
description: 结束时间
type: integer
id:
description: 轨道id
type: string
start:
description: 开始时间
type: integer
required:
- id
- start
- end
type: object
type: array
values:
description: 对应offsets的值,长度要一致,比如1|2,或者1|2|1
type: string
width:
description: 视频宽度
type: integer
required:
- ctype
- offsets
- segment_infos
- values
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
keyframes_infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 关键帧数据生成器
/objs_to_str_list:
post:
operationId: objs_to_str_list
requestBody:
content:
application/json:
schema:
properties:
outputs:
description: 数据对象,接收get_outputs节点的输出
items:
description: 内容
properties:
output:
description: 内容
type: string
required:
- output
type: object
type: array
required:
- outputs
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
items:
type: string
type: array
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 对象列表转化成字符串列表
/save_draft:
post:
operationId: save_draft
requestBody:
content:
application/json:
schema:
properties:
draft_url:
description: 剪映草稿地址,由创建草稿插件create_draft返回。
type: string
required:
- draft_url
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
draft_url:
type: string
message:
type: string
type: object
description: new desc
default:
description: ""
summary: 保存剪映草稿
/search_sticker:
post:
operationId: search_sticker
requestBody:
content:
application/json:
schema:
properties:
keyword:
description: 关键词
type: string
required:
- keyword
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
data:
items:
properties:
sticker:
properties:
large_image:
properties:
image_url:
type: string
type: object
preview_cover:
type: string
sticker_package:
properties:
height_per_frame:
type: number
size:
type: number
width_per_frame:
type: number
type: object
sticker_type:
type: number
track_thumbnail:
type: string
type: object
sticker_id:
type: string
title:
type: string
type: object
type: array
message:
type: string
type: object
description: new desc
default:
description: ""
summary: 查找贴纸
/str_list_to_objs:
post:
operationId: str_list_to_objs
requestBody:
content:
application/json:
schema:
properties:
infos:
description: 列表内容
items:
description: 内容
type: string
type: array
required:
- infos
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
items:
properties:
output:
type: string
type: object
type: array
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 字符串列表转化成对象列表
/str_to_list:
post:
operationId: str_to_list
requestBody:
content:
application/json:
schema:
properties:
obj:
description: 对象内容
type: string
required:
- obj
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
items:
type: string
type: array
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 字符转列表
/timelines:
post:
operationId: timelines
requestBody:
content:
application/json:
schema:
properties:
duration:
description: 总长度,单位微秒,eg:10000000
type: integer
num:
description: 时间线上的个数
type: integer
start:
default: 0
description: 默认开始0,如果设置了,就从start开始
type: integer
type:
default: 0
description: 方式,0平均分,1 随机,默认0
type: integer
required:
- duration
- num
type: object
responses:
"200":
content:
application/json:
schema:
properties:
all_timelines:
items:
properties:
end:
type: number
start:
type: number
type: object
type: array
code:
type: number
x-global-disable: true
message:
type: string
x-global-disable: true
timelines:
items:
properties:
end:
type: number
start:
type: number
type: object
type: array
type: object
description: new desc
default:
description: ""
summary: 自定义创建时间线列表
/video_infos:
post:
operationId: video_infos
requestBody:
content:
application/json:
schema:
properties:
height:
description: 视频高度
type: string
mask:
description: 视频蒙版,可填写值:圆形,矩形,爱心,星形
type: string
timelines:
description: 时间节点,只接收结构:[{"start":0,"end":4612}],一般从audio_timeline节点的输出获取
items:
description: 时间线
properties:
end:
description: 结束时间
type: integer
start:
description: 开始时间
type: integer
required:
- start
- end
type: object
type: array
transition:
description: 转场
type: string
transition_duration:
description: 转场的时长
type: integer
video_urls:
description: 视频列表
items:
description: 视频链接
type: string
type: array
volume:
description: 音量大小,0-10,默认1
type: number
width:
description: 视频宽度
type: integer
required:
- video_urls
- timelines
type: object
responses:
"200":
content:
application/json:
schema:
properties:
code:
type: number
x-global-disable: true
infos:
type: string
message:
type: string
x-global-disable: true
type: object
description: new desc
default:
description: ""
summary: 根据时间线制作视频数据
servers:
- url: https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1