From ee7cdec9e3d510c137c4ecddd1131f957d445f8a Mon Sep 17 00:00:00 2001 From: seaislee1209 Date: Sat, 4 Apr 2026 13:27:13 +0800 Subject: [PATCH] add docs --- ...称】Seedance 2.0 & 2.0 fast API文档(邀测用户版).md | 961 +++++++++++++ ...·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md | 1005 ++++++++++++++ ...ance 2.0 & 2.0 fast API文档(邀测用户版).md | 692 ++++++++++ ...·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md | 1201 +++++++++++++++++ ...·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版).md | 128 ++ ...®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版).md | 314 +++++ docs/API文档/关于ç§å­å€¼.md | 487 +++++++ docs/API文档/推ç†èŠ‚ç‚¹.md | 1074 +++++++++++++++ 8 files changed, 5862 insertions(+) create mode 100644 docs/API文档/3-28-ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版).md create mode 100644 docs/API文档/3-31「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md create mode 100644 docs/API文档/old-Seedance 2.0 & 2.0 fast API文档(邀测用户版).md create mode 100644 docs/API文档/old-「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md create mode 100644 docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版).md create mode 100644 docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版).md create mode 100644 docs/API文档/关于ç§å­å€¼.md create mode 100644 docs/API文档/推ç†èŠ‚ç‚¹.md diff --git a/docs/API文档/3-28-ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版).md b/docs/API文档/3-28-ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版).md new file mode 100644 index 0000000..8b55529 --- /dev/null +++ b/docs/API文档/3-28-ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版).md @@ -0,0 +1,961 @@ +# ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版) + +该文档目å‰ä»…é™å¼€ç™½å®¢æˆ·ä½¿ç”¨ï¼Œå‘é€å‰è¯·å’Œé”€ç®¡ç¡®è®¤å®¢æˆ·æ˜¯å¦åœ¨å¼€ç™½åå•内 + +***ã€â—ï¸â—ï¸â—ï¸ã€‘该文档é™åˆ¶å®¢æˆ·ç”³è¯·æƒé™ï¼Œåªæœ‰è¿”回了æœåŠ¡å议的客户方å¯ç”³è¯·*** + +æœ¬æ–‡ä»‹ç» Seedance 2.0 & 2.0 fast æ¨¡åž‹ç›¸è¾ƒäºŽå­˜é‡æ¨¡åž‹ **新增/é…置有区别 **的 API 傿•°ä»‹ç»ï¼Œå­˜é‡ API 傿•°çš„完整介ç»å‚è§ [è§†é¢‘ç”Ÿæˆ API](https://www.volcengine.com/docs/82379/1520758?lang=zh)。 + +> 本文档仅é™é¢„览åŠé‚€æµ‹ç”¨æˆ·ä½¿ç”¨ï¼š +> +> * 䏿‰¿è¯ºæ­£å¼API上线100%一致。 +> +> * ä»…é™é‚€æµ‹ç”¨æˆ·é˜…读,请勿截图/分享给其他人员。 +> +> * 您上传的内容请确ä¿ç”±æ‚¨åŽŸåˆ›æˆ–å·²å–得授æƒã€‚ + +# 模型能力 + +> **Seedance 2.0 å’Œ Seedance 2.0 fast æä¾›çš„æ¨¡åž‹èƒ½åŠ›ä¸€è‡´ï¼Œ**追求最高生æˆå“质,推è使用 **Seedance 2.0**ï¼›æ›´æ³¨é‡æˆæœ¬ä¸Žç”Ÿæˆé€Ÿåº¦ï¼Œä¸è¦æ±‚æžé™å“质,推è使用 **Seedance 2.0 fast**。 + +**Seedance 2.0 & 2.0 fast (有声视频/无声视频)** + +* **多模æ€å‚考生视频**:输入å‚考图片(0\~9)+å‚考视频(0\~3)+ å‚考音频(0\~3)+ 文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。支æŒç”Ÿæˆå…¨æ–°è§†é¢‘ã€ç¼–辑视频ã€å»¶é•¿è§†é¢‘。 + +> **注æ„:ä¸å¯å•ç‹¬è¾“å…¥éŸ³é¢‘ï¼Œåº”è‡³å°‘åŒ…å« 1 个å‚考视频或图片。** + +* **图生视频-首尾帧**:输入首帧图片+尾帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。 + +* **图生视频-首帧**:输入首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。 + +* **文生视频**:输入文本æç¤ºè¯ç”Ÿæˆ 1 个目标视频。 + + + +**模型能力对比表:** + +| 模型åç§° | | [Seedance 2.0](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-2-0) | [Seedance 2.0 fast](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-2-0-fast\&projectName=default) | [Seedance 1.5 pro](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-5-pro\&projectName=default) | [Seedance 1.0 pro ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-pro\&projectName=default) | [Seedance 1.0 pro fast ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-pro-fast\&projectName=default) | [Seedance 1.0 lite i2v](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-lite-i2v\&projectName=default) | [Seedance-1.0 lite t2v ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-lite-t2v) | +| ------------ | -------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| Model ID | | doubao-seedance-2-0-260128 | doubao-seedance-2-0-fast-260128 | doubao-seedance-1-5-pro-251215 | doubao-seedance-1-0-pro-250528 | doubao-seedance-1-0-pro-fast-251015 | doubao-seedance-1-0-lite-i2v-250428 | doubao-seedance-1-0-lite-t2v-250428 | +| 文生视频 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 图生视频-首帧 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ⌠| +| 图生视频-首尾帧 | | ✅ | | ✅ | ✅ | ⌠| ✅ | ⌠| +| 多模æ€å‚考ã€New】 | 图片å‚考 | ✅ | | ⌠| ⌠| ⌠| ✅ | ⌠| +| | 视频å‚考 | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| | 组åˆå‚考 | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| 编辑视频ã€New】 | | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| 延长视频ã€New】 | | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| ç”Ÿæˆæœ‰å£°è§†é¢‘ | | ✅ | | ✅ | ⌠| ⌠| ⌠| ⌠| +| è”网æœç´¢å¢žå¼ºã€New】 | | ✅ | | ⌠| [âŒ](https://p9-arcosite.byteimg.com/obj/tos-cn-i-goo7wpa0wc/f359753773c94d97885008ca1223c9bc) | ⌠| ⌠| ⌠| +| æ ·ç‰‡æ¨¡å¼ | | ⌠| | ✅ | ⌠| ⌠| ⌠| ⌠| +| 返回视频尾帧 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 输出视频规格 | 输出分辨率 | 480p, 720p | | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | +| | 输出宽高比 | 21:9, 16:9, 4:3, 1:1, 3:4, 9:16 | | | | | | | +| | 输出时长 | 4\~15 ç§’ | | 4\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | +| | è¾“å‡ºè§†é¢‘æ ¼å¼ | mp4 | | mp4 | mp4 | mp4 | mp4 | mp4 | +| ç¦»çº¿æŽ¨ç† | | [âŒ](https://p9-arcosite.byteimg.com/obj/tos-cn-i-goo7wpa0wc/f359753773c94d97885008ca1223c9bc) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 在线推ç†é™æµ | RPM | 600 | | 600 | 600 | 600 | 300 | 300 | +| | 并呿•° | 10 | | 10 | 10 | 10 | 5 | 5 | +| 离线推ç†é™æµ | TPD | - | | 5000亿 | 5000亿 | 5000亿 | 2500亿 | 2500亿 | + + + + + +# Creat-创建视频生æˆä»»åŠ¡ + +> POST https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks + +## è¯·æ±‚å‚æ•° + + + +#### **content** `object[]` `必选` + +输入给模型,生æˆè§†é¢‘的信æ¯ï¼Œæ”¯æŒæ–‡æœ¬ã€å›¾ç‰‡ã€éŸ³é¢‘ã€è§†é¢‘ã€æ ·ç‰‡ä»»åŠ¡ ID。支æŒä»¥ä¸‹å‡ ç§ç»„åˆï¼š + +* **文本** + +* **文本(å¯é€‰ï¼‰+ 图片** + +* **文本(å¯é€‰ï¼‰+ 视频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 音频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 视频** + +* **文本(å¯é€‰ï¼‰+ 视频 + 音频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 视频 + 音频** + +*** + +**ä¿¡æ¯ç±»åž‹ï¼š** + +* **文本信æ¯**`object` + +输入给模型的æç¤ºè¯ä¿¡æ¯ã€‚ + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **text**。 + +*** + +content.**text **`string` `必选` + +输入给模型的文本æç¤ºè¯ï¼Œæè¿°æœŸæœ›ç”Ÿæˆçš„视频。 + +支æŒä¸­è‹±æ–‡ã€‚建议中文ä¸è¶…过500字,英文ä¸è¶…过1000è¯ã€‚字数过多信æ¯å®¹æ˜“分散,模型å¯èƒ½å› æ­¤å¿½ç•¥ç»†èŠ‚ï¼Œåªå…³æ³¨é‡ç‚¹ï¼Œé€ æˆè§†é¢‘缺失部分元素。æç¤ºè¯çš„æ›´å¤šä½¿ç”¨æŠ€å·§è¯·å‚è§ [Seedance æç¤ºè¯æŒ‡å—](https://www.volcengine.com/docs/82379/1587797)。 + + + + + +* **图片信æ¯** `object` + +输入给模型的图片信æ¯ã€‚ + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **image\_url**。 + +*** + +content.**image\_url **`object` `必选` + +输入给模型的图片对象。 + +*** + +content.image\_url.**url **`string` `必选` + +图片 URL ã€å›¾ç‰‡ Base64 ç¼–ç ã€ç´ æ ID。 + +* 图片 URL:填入图片的公网 URL。 + +* Base64 ç¼–ç ï¼šå°†æœ¬åœ°æ–‡ä»¶è½¬æ¢ä¸º Base64 ç¼–ç å­—ç¬¦ä¸²ï¼Œç„¶åŽæäº¤ç»™å¤§æ¨¡åž‹ã€‚éµå¾ªæ ¼å¼ï¼šdata:image/<图片格å¼>;base64,\ï¼Œæ³¨æ„ <图片格å¼> 需å°å†™ï¼Œå¦‚ data:image/png;base64,{base64\_image}。 + +* ç´ æ ID:用于视频生æˆçš„预置素æåŠè™šæ‹Ÿäººåƒçš„ ID,éµå¾ªæ ¼å¼ï¼šasset://\,å¯ä»Ž [ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128) 获å–,详细使用请å‚è§[文档](https://www.volcengine.com/docs/82379/2223965?lang=zh)。 + +> **ä¼ å…¥å•å¼ å›¾ç‰‡è¦æ±‚** +> +> * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gif +> +> * 宽高比(宽/高): (0.4, 2.5) +> +> * 宽高长度(px):(300, 6000) +> +> * 大å°ï¼šå•张图片å°äºŽ 30 MB。请求体大å°ä¸è¶…过 64 MB。大文件请勿使用Base64ç¼–ç ã€‚ +> +> * 图片数é‡ï¼š +> +> * 图生视频-首帧:1 å¼  +> +> * 图生视频-首尾帧:2 å¼  +> +> * Seedance 2.0 & 2.0 fast 多模æ€å‚考生视频:1\~9 å¼  + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +图片的ä½ç½®æˆ–用途。 + +> **注æ„** +> +> * **图生视频-首帧**ã€**图生视频-首尾帧**ã€**多模æ€å‚考生视频**(包括å‚考图ã€è§†é¢‘ã€éŸ³é¢‘)为 3 ç§äº’斥场景,**ä¸å¯æ··ç”¨**。 +> +> * **多模æ€å‚考生视频**å¯é€šè¿‡æç¤ºè¯æŒ‡å®šå‚考图片作为首帧/尾帧,间接实现“首尾帧+多模æ€å‚è€ƒâ€æ•ˆæžœã€‚若需严格ä¿éšœé¦–尾帧和指定图片一致,**优先使用图生视频-首尾帧**(é…ç½® role 为 **first\_frame / last\_frame**)。 + +*** + +**图生视频-首帧** + +> 需è¦ä¼ å…¥1个 image\_url 对象 + +* **字段roleå–值:** + + * **first\_frame 或ä¸å¡«** + +*** + +**图生视频-首尾帧** + +> 需è¦ä¼ å…¥2个 image\_url 对象 + +* **字段roleå–值:** + + * 首帧图片对应的字段 role 为:**first\_frame**,必填 + + * 尾帧图片对应的字段 role 为:**last\_frame**,必填 + +*** + +**图生视频-å‚考图 ** + +> å¯ä¼ å…¥ 1\~9 个 image\_url 对象 + +* **字段roleå–值**: + + * æ¯å¼ å‚考图对应的字段 role å‡ä¸ºï¼š**reference\_image**,必填 + + + + + +* **视频信æ¯** `object` + +输入给模型的视频信æ¯ã€‚ä»… Seedance 2.0 & 2.0 fast 支æŒè¾“入视频。2026å¹´3月11日起,支æŒä½¿ç”¨æœ¬è´¦å·ä¸‹ Seedance 2.0 & 2.0 fast 模型产出的视频作为输入素æï¼Œè¿›è¡Œè§†é¢‘ç¼–è¾‘æˆ–å»¶é•¿ï¼Œå…¶ä¸­çš„çœŸäººäººè„¸å¯æ­£å¸¸ä½¿ç”¨ï¼Œä¸ä¼šè§¦å‘审核拦截。 + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **video\_url**。 + +*** + +content.**video\_url **`object` `必选` + +输入给模型的视频对象。 + +*** + +content.video\_url.**url **`string` `必选` + +视频URLã€ç´ æ ID。 + +* 视频 URL:填入视频的公网 URL。 + +* ç´ æ ID:用于视频生æˆçš„预置素æåŠè™šæ‹Ÿäººåƒè§†é¢‘çš„ ID,éµå¾ªæ ¼å¼ï¼šasset://\。å¯ä»Ž[ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获å–。 + +> **ä¼ å…¥å•ä¸ªè§†é¢‘è¦æ±‚** +> +> * 视频格å¼ï¼šmp4ã€mov。 +> +> * 分辨率:480pã€720p +> +> * 时长:å•个视频时长 \[2, 15] s,最多传入 3 个å‚考视频,所有视频总时长ä¸è¶…过 15s。 +> +> * 尺寸: +> +> * 宽高比(宽/高):\[0.4, 2.5] +> +> * 宽高长度(px):\[300, 6000] +> +> * ç”»é¢åƒç´ ï¼ˆå®½ × 高):\[409600, 927408] ,示例: +> +> * ç”»é¢å°ºå¯¸ 640×640=409600 满足最å°å€¼ ï¼› +> +> * ç”»é¢å°ºå¯¸ 834×1112=927408 满足最大值。 +> +> * 大å°ï¼šå•个视频ä¸è¶…过 50 MB。 +> +> * 帧率 (FPS):\[24, 60] + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +视频的ä½ç½®æˆ–用途。当å‰ä»…æ”¯æŒ **reference\_video**。 + + + + + +* **éŸ³é¢‘ä¿¡æ¯ **`object` + +输入给模型的音频信æ¯ã€‚ä»… Seedance 2.0 & 2.0 fast 支æŒè¾“入音频。注æ„ä¸å¯å•ç‹¬è¾“å…¥éŸ³é¢‘ï¼Œåº”è‡³å°‘åŒ…å« 1 个å‚考视频或图片。 + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **audio\_url**。 + +*** + +content.**audio\_url **`object` `必选` + +输入给模型的音频对象。 + +*** + +content.audio\_url.**url **`string` `必选` + +音频 URL ã€éŸ³é¢‘ Base64 ç¼–ç ã€ç´ æ ID。 + +* 音频 URL:填入音频的公网 URL。 + +* Base64 ç¼–ç ï¼šå°†æœ¬åœ°æ–‡ä»¶è½¬æ¢ä¸º Base64 ç¼–ç å­—ç¬¦ä¸²ï¼Œç„¶åŽæäº¤ç»™å¤§æ¨¡åž‹ã€‚éµå¾ªæ ¼å¼ï¼šdata:audio/<音频格å¼>;base64,\ï¼Œæ³¨æ„ <音频格å¼> 需å°å†™ï¼Œå¦‚ data:audio/wav;base64,{base64\_audio}。 + +* ç´ æ ID:用于视频生æˆçš„虚拟人的音频素æ ID,éµå¾ªæ ¼å¼ï¼šasset://\。å¯ä»Ž[ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获å–。 + +> **ä¼ å…¥å•ä¸ªéŸ³é¢‘è¦æ±‚** +> +> * æ ¼å¼ï¼šwavã€mp3 +> +> * 时长:å•个音频时长 \[2, 15] s,最多传入 3 段å‚考音频,所有音频总时长ä¸è¶…过 15 s。 +> +> * 大å°ï¼šå•个音频ä¸è¶…过 15 MB,请求体大å°ä¸è¶…过 64 MB。大文件请勿使用Base64ç¼–ç ã€‚ + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +音频的ä½ç½®æˆ–用途。当å‰ä»…æ”¯æŒ **reference\_audio** 。 + + + +#### **service\_tier** `string` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **generate\_audio **`boolean` + +> Seedance 2.0 & 2.0 fast 默认值: true + +控制生æˆçš„视频是å¦åŒ…å«ä¸Žç”»é¢åŒæ­¥çš„声音。 + +* true:模型输出的视频包å«åŒæ­¥éŸ³é¢‘。模型会基于文本æç¤ºè¯ä¸Žè§†è§‰å†…容,自动生æˆä¸Žä¹‹åŒ¹é…的人声ã€éŸ³æ•ˆåŠèƒŒæ™¯éŸ³ä¹ã€‚建议将对è¯éƒ¨åˆ†ç½®äºŽåŒå¼•å·å†…ï¼Œä»¥ä¼˜åŒ–éŸ³é¢‘ç”Ÿæˆæ•ˆæžœã€‚例如:男人å«ä½å¥³äººè¯´ï¼šâ€œä½ è®°ä½ï¼Œä»¥åŽä¸å¯ä»¥ç”¨æ‰‹æŒ‡æŒ‡æœˆäº®ã€‚†+ +* false:模型输出的视频为无声视频。 + +> **说明** +> +> 生æˆçš„æœ‰å£°è§†é¢‘å‡ä¸ºå•声é“ï¼Œå’Œä¼ å…¥çš„éŸ³é¢‘å£°é“æ•°æ— å…³ã€‚ + +#### + +#### **draft **`boolean` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **tools **`object[]` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +é…置模型è¦è°ƒç”¨çš„工具。 + +*** + +tools.**type **`string` + +指定使用的工具类型。 + +* web\_search:è”网æœç´¢å·¥å…·ã€‚当å‰ä»…文生视频支æŒã€‚ + +> **说明** +> +> * å¼€å¯è”网æœç´¢åŽï¼Œæ¨¡åž‹ä¼šæ ¹æ®ç”¨æˆ·çš„æç¤ºè¯è‡ªä¸»åˆ¤æ–­æ˜¯å¦æœç´¢äº’è”网内容(如商å“ã€å¤©æ°”ç­‰ï¼‰ã€‚å¯æå‡ç”Ÿæˆè§†é¢‘的时效性,但也会增加一定的时延。 +> +> * 实际æœç´¢æ¬¡æ•°å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 usage.tool\_usage.**web\_search** 字段获å–,如果为 0 表示未æœç´¢ã€‚ + + + +#### **resolution ** `string` + +> Seedance 2.0 & 2.0 fast 默认值:720p + +视频分辨率,å–值范围: + +* 480p + +* 720p + + + +#### **ratio **`string` + +> Seedance 2.0 & 2.0 fast 默认值: adaptive + +生æˆè§†é¢‘的宽高比例。ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼è§ä¸‹æ–¹è¡¨æ ¼ã€‚ + +* 16:9 + +* 4:3 + +* 1:1 + +* 3:4 + +* 9:16 + +* 21:9 + +* adaptive:根æ®è¾“入自动选择最åˆé€‚的宽高比 + +> **adaptive 适é…规则** +> +> 当é…ç½® **ratio** 为 adaptive 时,模型会根æ®ç”Ÿæˆåœºæ™¯è‡ªåЍ适é…宽高比;实际生æˆçš„视频宽高比å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **ratio** 字段获å–。 +> +> * 文生视频:根æ®è¾“入的æç¤ºè¯ï¼Œæ™ºèƒ½é€‰æ‹©æœ€åˆé€‚的宽高比。 +> +> * 首帧 / 首尾帧生视频:根æ®ä¸Šä¼ çš„首帧图片比例,自动选择最接近的宽高比。 +> +> * 多模æ€å‚考生视频:根æ®ç”¨æˆ·æç¤ºè¯æ„图判断,如果是首帧生视频/编辑视频/延长视频,以该图片/视频为准选择最接近的宽高比;å¦åˆ™ï¼Œä»¥ä¼ å…¥çš„第一个媒体文件为准(优先级:视频>图片)选择最接近的宽高比。 + +*** + +**ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼ï¼š** + +| 分辨率 | 宽高比 | 宽高åƒç´ å€¼ | +| ---- | ---- | -------- | +| 480p | 16:9 | 864×496 | +| | 4:3 | 752×560 | +| | 1:1 | 640×640 | +| | 3:4 | 560×752 | +| | 9:16 | 496×864 | +| | 21:9 | 992×432 | +| 720p | 16:9 | 1280×720 | +| | 4:3 | 1112×834 | +| | 1:1 | 960×960 | +| | 3:4 | 834×1112 | +| | 9:16 | 720×1280 | +| | 21:9 | 1470×630 | + + + +#### **duration** `integer` + +> Seedance 2.0 & 2.0 fast 默认值:5 + +生æˆè§†é¢‘æ—¶é•¿ï¼Œä»…æ”¯æŒæ•´æ•°ï¼Œå•ä½ï¼šç§’。 + +å–值范围: + +* \[4,15] 或设置为-1 + +> **é…置方法** +> +> * æŒ‡å®šå…·ä½“æ—¶é•¿ï¼šæ”¯æŒæœ‰æ•ˆèŒƒå›´å†…的任一整数。 +> +> * 智能指定:设置为 -1,表示由模型在有效范围内自主选择åˆé€‚的视频长度(整数秒)。实际生æˆè§†é¢‘的时长å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **duration** 字段获å–。注æ„视频时长与计费相关,请谨慎设置。 + + + +#### **frames** `integer` + +Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **camera\_fixed** `boolean` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +# Get/List-查询视频生æˆä»»åŠ¡/列表 + +> [查询视频生æˆä»»åŠ¡](https://www.volcengine.com/docs/82379/1521309?lang=zh):GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks/{id} +> +> [查询视频生æˆä»»åŠ¡åˆ—è¡¨](https://www.volcengine.com/docs/82379/1521675?lang=zh):GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks?page\_num={page\_num}\&page\_size={page\_size}\&filter.status={filter.status}\&filter.task\_ids={filter.task\_ids}\&filter.model={filter.model} + +## å“åº”å‚æ•° + +#### **tools **`object[]` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +é…置模型è¦è°ƒç”¨çš„工具。 + +*** + +tools.**type **`string` + +指定使用的工具类型。 + +* web\_search:è”网æœç´¢å·¥å…·ã€‚ + + + +#### **usage** `object` + +本次请求的 token 用é‡ã€‚ + +*** + +usage.**completion\_tokens** `integer` + +模型输出视频花费的 token æ•°é‡ã€‚ + +*** + +usage.**total\_tokens** `integer` + +本次请求消耗的总 token æ•°é‡ã€‚ + +*** + +usage.**tool\_usage **`object` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +使用工具的用é‡ä¿¡æ¯ã€‚ + +*** + +usage.tool\_usage.**web\_search **`integer` + +实际调用è”网æœç´¢å·¥å…·çš„æ¬¡æ•°ï¼Œä»…å¼€å¯è”网æœç´¢æ—¶è¿”回。 + + + +# 调用简介åŠç¤ºä¾‹ + +## æµç¨‹ç®€ä»‹ + +ä»»åŠ¡æŽ¥å£æ˜¯å¼‚步接å£ï¼Œè§†é¢‘生æˆä»»åŠ¡æµç¨‹ + +1. 创建视频生æˆä»»åŠ¡æŽ¥å£åˆ›å»ºè§†é¢‘生æˆä»»åŠ¡ + +2. å®šæ—¶ä½¿ç”¨æŸ¥è¯¢æŽ¥å£æŸ¥è¯¢è§†é¢‘生æˆä»»åŠ¡çŠ¶æ€ + + 1. 任务 runningï¼Œè¿‡æ®µæ—¶é—´å†æŸ¥è¯¢ä»»åŠ¡çŠ¶æ€ + + 2. 任务完æˆï¼Œè¿”回视频链接,在24å°æ—¶å†…下载生æˆçš„视频文件 + +## 1. 创建视频生æˆä»»åŠ¡ + +> 以下示例仅展示 Seedance 2.0 & 2.0 fast 新增能力,更多视频生æˆç¤ºä¾‹è¯¦è§ [创建视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1520757)。 + +### 多模æ€å‚考 + +```bash +curl https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $ARK_API_KEY" \ + -d '{ + "model": "doubao-seedance-2-0-260128", + "content": [ + { + "type": "text", + "text": "全程使用视频1的第一视角构图,全程使用音频1作为背景音ä¹ã€‚第一人称视角果茶宣传广告,seedance牌「苹苹安安ã€è‹¹æžœæžœèŒ¶é™å®šæ¬¾ï¼›é¦–帧为图片1,你的手摘下一颗带晨露的阿克è‹çº¢è‹¹æžœï¼Œè½»è„†çš„苹果碰撞声;2-4 ç§’ï¼šå¿«é€Ÿåˆ‡é•œï¼Œä½ çš„æ‰‹å°†è‹¹æžœå—æŠ•å…¥é›ªå…‹æ¯ï¼ŒåР入冰å—与茶底,用力摇晃,冰å—碰撞声与摇晃声å¡ç‚¹è½»å¿«é¼“点,背景音:「鲜切现摇ã€ï¼›4-6 秒:第一人称æˆå“ç‰¹å†™ï¼Œåˆ†å±‚æžœèŒ¶å€’å…¥é€æ˜Žæ¯ï¼Œä½ çš„æ‰‹è½»æŒ¤å¥¶ç›–在顶部铺展,在æ¯èº«è´´ä¸Šç²‰çº¢åŒ…标,镜头拉近看奶盖与果茶的分层纹ç†ï¼›6-8 秒:第一人称手æŒä¸¾æ¯ï¼Œä½ å°†å›¾ç‰‡2中的果茶举到镜头å‰ï¼ˆæ¨¡æ‹Ÿé€’到观众é¢å‰çš„视角),æ¯èº«æ ‡ç­¾æ¸…æ™°å¯è§ï¼ŒèƒŒæ™¯éŸ³ã€Œæ¥ä¸€å£é²œçˆ½ã€ï¼Œå°¾å¸§å®šæ ¼ä¸ºå›¾ç‰‡2。背景声音统一为女生音色。" + }, + { + "type": "image_url", + "image_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg" + }, + "role": "reference_image" + }, + { + "type": "image_url", + "image_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic2.jpg" + }, + "role": "reference_image" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_tea_video1.mp4" + }, + "role": "reference_video" + }, + { + "type": "audio_url", + "audio_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3" + }, + "role": "reference_audio" + } + ], + "generate_audio":true, + "ratio": "16:9", + "duration": 11, + "watermark": false +}' +``` + +### 编辑视频 + +```bash +curl https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $ARK_API_KEY" \ + -d '{ + "model": "doubao-seedance-2-0-260128", + "content": [ + { + "type": "text", + "text": "将视频1ç¤¼ç›’ä¸­çš„é¦™æ°´æ›¿æ¢æˆå›¾ç‰‡1中的é¢éœœï¼Œè¿é•œä¸å˜" + }, + { + "type": "image_url", + "image_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_edit_pic1.jpg" + }, + "role": "reference_image" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_edit_video1.mp4" + }, + "role": "reference_video" + } + ], + "generate_audio": true, + "ratio": "16:9", + "duration": 5, + "watermark": true +}' +``` + +### 延长视频 + +```bash +curl https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $ARK_API_KEY" \ + -d '{ + "model": "doubao-seedance-2-0-260128", + "content": [ + { + "type": "text", + "text": "视频1中的拱形窗户打开,进入美术馆室内,接视频2,之åŽé•œå¤´è¿›å…¥ç”»å†…,接视频3" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_extend_video1.mp4" + }, + "role": "reference_video" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_extend_video2.mp4" + }, + "role": "reference_video" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_extend_video3.mp4" + }, + "role": "reference_video" + } + ], + "generate_audio": true, + "ratio": "16:9", + "duration": 8, + "watermark": true +}' +``` + +### 使用è”网æœç´¢ + +ä»…æ”¯æŒæ–‡æœ¬ç”Ÿè§†é¢‘ + +```bash +curl https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $ARK_API_KEY" \ + -d '{ + "model": "doubao-seedance-2-0-260128", + "content": [ + { + "type": "text", + "text": "å¾®è·é•œå¤´å¯¹å‡†å¶ç‰‡ä¸Šç¿ ç»¿çš„çŽ»ç’ƒè›™ã€‚ç„¦ç‚¹é€æ¸ä»Žå®ƒå…‰æ»‘çš„çš®è‚¤ï¼Œè½¬ç§»åˆ°å®ƒå®Œå…¨é€æ˜Žçš„è…¹éƒ¨ï¼Œä¸€é¢—é²œçº¢çš„å¿ƒè„æ­£åœ¨æœ‰åŠ›åœ°ã€è§„律地收缩扩张。" + } + ], + "generate_audio":true, + "ratio": "16:9", + "duration": 11, + "watermark": true, + "tools": [ + { + "type": "web_search" + } + ] +}' +``` + +## 2. 查询视频生æˆä»»åŠ¡ + +```bash +//请将 cgt-2026****hzc2z 替æ¢ä¸ºåˆ›å»ºè§†é¢‘生æˆä»»åŠ¡æ—¶èŽ·å¾—çš„ä»»åŠ¡ID +curl -X GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks/cgt-2026****hzc2z \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $ARK_API_KEY" +``` + + + +# 最佳实践 + +## 使用公共虚拟人åƒç”Ÿæˆè§†é¢‘ + +å¹³å°æä¾›å…¬å…±è™šæ‹Ÿäººåƒç´ æåº“ï¼Œç›®å‰æ‚¨å¯ä»¥ä½¿ç”¨å…¶ä¸­çš„图åƒç´ ææ¥åˆ›å»ºä¸€ä¸ªç»Ÿä¸€ã€å®Œå¤‡çš„视频主角。帮助您更好地控制主角,并确ä¿å…¶å½¢è±¡åœ¨å¤šæ®µè§†é¢‘ä¸­ä¿æŒä¸€è‡´ï¼Œé¿å…因为真人人脸é™åˆ¶å¯¼è‡´è§’色无法统一的问题。 + +ç´ ææ¨¡æ€ç›®å‰åŒ…å«å›¾ç‰‡ï¼Œå¹¶æä¾›äººç‰©èƒŒæ™¯æè¿°ã€‚æ¯ä¸ªç´ æå¯¹åº”一个独立素æ ID (asset ID),在体验中心的视频生æˆä»»åŠ¡ä¸­ï¼ŒæŒ‡å®šè§’è‰²äººè„¸ç”Ÿæˆè§†é¢‘。 + +1. 在æµè§ˆå™¨ä¸­æ‰“å¼€[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo),点击输入框下方的 **虚拟人åƒåº“** 页签。 + +2. 检索需è¦ä½¿ç”¨çš„人åƒï¼Œæ”¯æŒä½¿ç”¨è‡ªç„¶è¯­è¨€æ£€ç´¢åŠç­›é€‰æ¡†ç»„åˆç­›é€‰ã€‚ + +| 输入:文本 | 输入:虚拟人åƒã€å›¾ç‰‡ | 输出 | +| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -- | +| **图片1**中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒ**图片2**çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。 | ![Image Token: HTf6bPRukoWaW4xnCSlcvKtUn7c](images/HTf6bPRukoWaW4xnCSlcvKtUn7c.png)![Image Token: YfCDbzJlqo4yzZxCmdscWdsInCf](images/YfCDbzJlqo4yzZxCmdscWdsInCf.jpeg) | | + + + +在 [Video Generation API](https://www.volcengine.com/docs/82379/1520758) çš„ **content.<模æ€>\_url.url** 字段中使用 ç´ æ URI 生æˆè§†é¢‘。 + +> 输入的å‚考内容,包括人åƒç´ æï¼Œéœ€ç¬¦åˆè§†é¢‘生æˆé™åˆ¶ï¼Œå…·ä½“ä¿¡æ¯è¯·æŸ¥çœ‹ä½¿ç”¨é™åˆ¶ã€‚ +> +> **注æ„**: +> +> * 首次在 API 中使用虚拟人åƒç´ æ Asset URI å‰ï¼Œéœ€å…ˆåœ¨[方舟体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo)æäº¤ä¸€æ¬¡è§†é¢‘生æˆä»»åŠ¡ï¼Œé˜…è¯»å¹¶åŒæ„弹出的 **虚拟人åƒåº“使用åè®®**。 +> +> * 体验中心支æŒä½“验视频生æˆèƒ½åŠ›ã€‚é»˜è®¤å•æ¬¡ç”Ÿæˆ 4 æ®µè§†é¢‘ï¼Œä¸ºèŠ‚çº¦æˆæœ¬ï¼Œå»ºè®®è®¾ç½®ä¸ºæ¯æ¬¡ç”Ÿæˆ 1 æ¡ï¼Œå…·ä½“æ–¹å¼å¯å‚考[虚拟人åƒåº“](https://www.volcengine.com/docs/82379/2223965?lang=zh)。 + +åŒæ„å议的æ“作方å¼å¦‚下: + +![Image Token: LK8ybUN9Ko2KkQxq2FdclVQtnkh](images/LK8ybUN9Ko2KkQxq2FdclVQtnkh.gif) + +示例代ç ï¼š + +> **注æ„:** +> 在传入给模型的 Prompt 中,需è¦ä½¿ç”¨**图片 1**ã€**视频 1 **的æ–¹å¼æŒ‡ä»£å‚考素æï¼Œç´ æåºå·ä¸ºç´ æåœ¨è¯·æ±‚体中的顺åºã€‚请勿直接在 Prompt 中直接使用 Asset ID。 +> 例:“**图片1 **里的女孩身ç€**图片2**中的æœè£…ï¼Œæ­£åœ¨æ•´ç†æŸœå°ä¸Šçš„物å“。**图片3**中的男孩是一ä½é¡¾å®¢ï¼Œä»–走上å‰ï¼Œæƒ³è¦å‘女孩索è¦è”系方å¼ã€‚†+> +> 调用示例请å‚考[常è§é—®é¢˜ 4](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe#share-YOKvdYHjro8EjtxucWaczf6vneg) + +```python +import os +import time +# Install SDK: pip install 'volcengine-python-sdk[ark]' +from volcenginesdkarkruntime import Ark +client = Ark( + # The base URL for model invocation + base_url='https://ark.cn-beijing.volces.com/api/v3', + # Get API Key:https://console.volcengine.com/ark/region:ark+cn-beijing/apikey + api_key=os.environ.get("ARK_API_KEY"), +) +if __name__ == "__main__": + print("----- create request -----") + create_result = client.content_generation.tasks.create( + model="doubao-seedance-2-0-260128", # Replace with Model ID + content=[ + { + "type": "text", + # 注æ„:素æå›¾ç‰‡æŒ‡ä»£éœ€ä½¿ç”¨â€œå›¾ç‰‡Nâ€ï¼ˆ N 表示传入素æå›¾ç‰‡/图片的åºå·ï¼Œå¦‚“图片1â€ã€â€œå›¾ç‰‡2â€ï¼‰ + "text": "图片1中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒå›¾ç‰‡2çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。" + }, + { + "type": "image_url", + "image_url": { + "url": "asset://asset-20260224200602-qn7wr" + }, + "role": "reference_image" + }, + { + "type": "image_url", + "image_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_edit_pic1.jpg" + }, + "role": "reference_image" + }, + ], + generate_audio=True, + ratio="16:9", + duration=11, + watermark=True, + ) + print(create_result) + print("----- polling task status -----") + task_id = create_result.id + while True: + get_result = client.content_generation.tasks.get(task_id=task_id) + status = get_result.status + if status == "succeeded": + print("----- task succeeded -----") + print(get_result) + break + elif status == "failed": + print("----- task failed -----") + print(f"Error: {get_result.error}") + break + else: + print(f"Current status: {status}, Retrying after 30 seconds...") + time.sleep(30) +``` + +*** + +## 使用自有虚拟人åƒç´ æç”Ÿæˆè§†é¢‘ + +Seedance 2.0 åŠ 2.0 fast 模型具有完备的防范 Deepfake 和侵犯版æƒé£Žé™©èƒ½åŠ›ã€‚åœ¨ç”Ÿæˆè§†é¢‘时,会对有风险的å‚考素æè¾“入进行拦截,最大é™åº¦ä¿è¯ç”Ÿæˆè§†é¢‘åˆè§„和安全性。 + +为确ä¿åˆ›ä½œè€…能充分利用 Seedance 2.0 系列模型强大的视频生æˆèƒ½åŠ›é«˜æ•ˆç”Ÿæˆè§†é¢‘å†…å®¹ï¼ŒåŒæ—¶è§„é¿ AI 生æˆå†…容的潜在风险,方舟推出了ç§åŸŸå¯ä¿¡ç´ æåº“,支æŒåˆ›ä½œè€…自助上传虚拟人åƒç´ æã€‚完æˆå…¥åº“çš„å¯ä¿¡ç´ æå°†è¿›å…¥æ‚¨çš„ç§åŸŸç´ æåº“,在视频生æˆä¸­ä½¿ç”¨ã€‚ + +> 具体信æ¯è¯·å‚考文档:[ 「⚠ï¸ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe)。 + +*** + +## 使用模型产物进行二创 + +Seedance 2.0 åŠ 2.0 fast 模型生æˆçš„视频为å—ä¿¡ç´ æã€‚您å¯ä½¿ç”¨**本账å·ä¸‹**由上述模型生æˆçš„视频,进行视频编辑ã€è§†é¢‘延长等二次创作,素æä¸­çš„äººè„¸å¯æ­£å¸¸å‚与生æˆï¼Œä¸ä¼šè§¦å‘审核拦截。 + +> 2026å¹´3月11日起,使用 Seedance 2.0 åŠ 2.0 fast 模型生æˆçš„视频,支æŒäºŒæ¬¡åˆ›ä½œã€‚ + +| 输入:文本 | 输入:虚拟人åƒã€å›¾ç‰‡ | 第一次输出视频 | 二次编辑åŽè§†é¢‘ | +| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------- | +| **图片1**中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒ**图片2**çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。 | ![Image Token: MbrRbjSSDoqaaKx3YmCcbVZUnud](images/MbrRbjSSDoqaaKx3YmCcbVZUnud.png)![Image Token: UGfibSj7soIYJMxoYpEcDBIcnkb](images/UGfibSj7soIYJMxoYpEcDBIcnkb.jpeg) | | | + +1. 首次生视频,并获å–视频 URL。 + +> **注æ„:** +> 在传入给模型的 Prompt 中,需è¦ä½¿ç”¨**图片 1**ã€**视频 1 **的æ–¹å¼æŒ‡ä»£å‚考素æï¼Œç´ æåºå·ä¸ºç´ æåœ¨è¯·æ±‚体中的顺åºã€‚ +> +> 请勿直接在 Prompt 中直接使用 Asset ID。 +> 例:“**图片1 **里的女孩身ç€**图片2**中的æœè£…ï¼Œæ­£åœ¨æ•´ç†æŸœå°ä¸Šçš„物å“。**图片3**中的男孩是一ä½é¡¾å®¢ï¼Œä»–走上å‰ï¼Œæƒ³è¦å‘女孩索è¦è”系方å¼ã€‚†+ +```python +import os +import time +# Install SDK: pip install 'volcengine-python-sdk[ark]' +from volcenginesdkarkruntime import Ark +client = Ark( + # The base URL for model invocation + base_url='https://ark.cn-beijing.volces.com/api/v3', + # Get API Key:https://console.volcengine.com/ark/region:ark+cn-beijing/apikey + api_key=os.environ.get("ARK_API_KEY"), +) +if __name__ == "__main__": + print("----- create request -----") + create_result = client.content_generation.tasks.create( + model="doubao-seedance-2-0-260128", # Replace with Model ID + content=[ + { + "type": "text", + # 注æ„:素æå›¾ç‰‡æŒ‡ä»£éœ€ä½¿ç”¨â€œå›¾ç‰‡Nâ€ï¼ˆ N 表示传入素æå›¾ç‰‡/图片的åºå·ï¼Œå¦‚“图片1â€ã€â€œå›¾ç‰‡2â€ï¼‰ + "text": "图片1中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒå›¾ç‰‡2çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。" + }, + { + "type": "image_url", + "image_url": { + "url": "asset://asset-20260224200602-qn7wr" + }, + "role": "reference_image" + }, + { + "type": "image_url", + "image_url": { + "url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_edit_pic1.jpg" + }, + "role": "reference_image" + }, + ], + generate_audio=True, + ratio="16:9", + duration=11, + watermark=True, + ) + print(create_result) + print("----- polling task status -----") + task_id = create_result.id + while True: + get_result = client.content_generation.tasks.get(task_id=task_id) + status = get_result.status + if status == "succeeded": + print("----- task succeeded -----") + print(get_result) + break + elif status == "failed": + print("----- task failed -----") + print(f"Error: {get_result.error}") + break + else: + print(f"Current status: {status}, Retrying after 30 seconds...") + time.sleep(30) +``` + +* 对首次生æˆçš„è§†é¢‘è¿›è¡Œå†æ¬¡ç¼–辑。为直观展示效果,本示例中直接使用视频原始 URL。 + +> 视频原始 URL 的有效期仅 24 å°æ—¶ï¼Œå®žé™…使用时,建议您æå‰è½¬å­˜è§†é¢‘文件(例如上传至ç«å±±å¼•擎TOS)。 + +```python +import os +import time +# Install SDK: pip install 'volcengine-python-sdk[ark]' +from volcenginesdkarkruntime import Ark +client = Ark( + # The base URL for model invocation + base_url='https://ark.cn-beijing.volces.com/api/v3', + # Get API Key:https://console.volcengine.com/ark/region:ark+cn-beijing/apikey + api_key=os.environ.get("ARK_API_KEY"), +) +if __name__ == "__main__": + print("----- create request -----") + create_result = client.content_generation.tasks.create( + model="doubao-seedance-2-0-260128", # Replace with Model ID + content=[ + { + "type": "text", + "text": "将视频1中的背景修改为室内,房间布置温馨,包括白色的沙å‘,梳妆å°å’Œé²œèŠ±ã€‚" + }, + { + "type": "video_url", + "video_url": { + "url": "https://ark-acg-cn-beijing.tos-cn-beijing.volces.com/doubao-seedance-2-0/02177390693606300000000000000000000ffffc0a88a7fb18e5d.mp4?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKLTMjQyZTA4MzFjYTY0NGE5YzgzNTIzMTQzYWI5MmVjMDY%2F20260319%2Fcn-beijing%2Ftos%2Frequest&X-Tos-Date=20260319T075900Z&X-Tos-Expires=86400&X-Tos-Signature=204c1d922d7f563ab0fe2bdf28fe3764df52b3404827acf11c9f3dead82aa3db&X-Tos-SignedHeaders=host" + }, + "role": "reference_video" + }, + ], + generate_audio=True, + ratio="16:9", + duration=11, + watermark=True, + ) + print(create_result) + print("----- polling task status -----") + task_id = create_result.id + while True: + get_result = client.content_generation.tasks.get(task_id=task_id) + status = get_result.status + if status == "succeeded": + print("----- task succeeded -----") + print(get_result) + break + elif status == "failed": + print("----- task failed -----") + print(f"Error: {get_result.error}") + break + else: + print(f"Current status: {status}, Retrying after 30 seconds...") + time.sleep(30) +``` + + + +## ç§åŸŸç´ æèµ„产上传最佳案例 + +> 在上传素æèµ„产时,**若将目标人脸图ã€å…¨èº«å‚考图åŠç»†èŠ‚å‚考图åˆå¹¶ä¸ºåŒä¸€å¼ å›¾ç‰‡ï¼Œå¯èƒ½å¯¼è‡´å„å‚考元素在画é¢ä¸­å æ¯”较å°ï¼Œä»Žè€Œå¢žåŠ æ¨¡åž‹è¯†åˆ«éš¾åº¦**,造æˆç”Ÿæˆè§†é¢‘中的人物形象与所上传素æèµ„产出现å差,或造æˆç”Ÿæˆè§†é¢‘中素人脸被误识别为明星脸而触å‘风控拦截。 + +建议在上传素æèµ„产时,将人物é¢éƒ¨ç‰¹å†™ã€æœè£…细节等关键内容独立分割为å•独的图片进行上传。具体å¯å‚考如下规则åŠç¤ºä¾‹ï¼š + +| | 应该 | ä¸åº”该 | | +| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 输入内容 | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…ç‰¹å†™å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: Hi55bqOYyoBWvSxMDjNcEuSJn7c)](images/Hi55bqOYyoBWvSxMDjNcEuSJn7c.png)![图片2-人物妆造三视图 (Token: XQE5bI0tJovdxmxf0qMcFCtEnoc)](images/XQE5bI0tJovdxmxf0qMcFCtEnoc.png)![图片3-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: BpkhbHY0Co0pB0xTgoRcLDOynGc)](images/BpkhbHY0Co0pB0xTgoRcLDOynGc.png) | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: T572bL5IGooP4HxogzGcwERRn5c)](images/T572bL5IGooP4HxogzGcwERRn5c.png)![图片2-人物妆造三视图 (Token: WZIcbGijXoOOZnxQRS9cA4kMndh)](images/WZIcbGijXoOOZnxQRS9cA4kMndh.png) | | +| 输出内容 | | | | +| 总结 | åŒæ ·æ˜¯å¤é£Žæ‰“斗剧情:左边输入内容包括:背景å‚考图ã€**人物妆造三视图**ã€**人物é¢éƒ¨æ— è¡¨æƒ…特写图**ã€æç¤ºè¯ï¼›ä¸­é—´è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯ï¼›å³è¾¹è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ æ­£è§†å›¾ã€æç¤ºè¯ã€‚左边的输出视频更加还原人物é¢éƒ¨ç‰¹å¾ï¼›å³è¾¹çš„人物é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ã€‚ | | | +| 输入内容 | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…ç‰¹å†™å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: JLD7bmUBYo7FpaxiAsicLkMQnKe)](images/JLD7bmUBYo7FpaxiAsicLkMQnKe.jpeg)![图片2-人物妆造三视图 (Token: Xj45b0L5uopyMqxTUOLcwn0ZnCc)](images/Xj45b0L5uopyMqxTUOLcwn0ZnCc.jpeg)![图片3-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: S7JRbu09Jo9OdkxHy7TcWTarnRh)](images/S7JRbu09Jo9OdkxHy7TcWTarnRh.png)![图片4-人物妆造三视图 (Token: KS5hb2DlCoLL6uxHnfdcl9konBe)](images/KS5hb2DlCoLL6uxHnfdcl9konBe.jpeg)![图片5-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: NtOnbySAHokJ4JxR4sdcu8oRnyh)](images/NtOnbySAHokJ4JxR4sdcu8oRnyh.jpeg) | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: I3ICbosi0oaR1LxcezKcYJWCnic)](images/I3ICbosi0oaR1LxcezKcYJWCnic.jpeg)![图片2-人物妆造三视图 (Token: JtOLbQ1iLoxTPUxXrkLcMcXknB8)](images/JtOLbQ1iLoxTPUxXrkLcMcXknB8.jpeg)![图片3-人物妆造三视图 (Token: RGoubMdjTokEK3xjJ3KcQqPtnuf)](images/RGoubMdjTokEK3xjJ3KcQqPtnuf.jpeg) | 给出背景å‚考图ã€äººç‰©å¦†é€ æ­£è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: YCcmbhQVFoUcHcxExHfcSrSQnab)](images/YCcmbhQVFoUcHcxExHfcSrSQnab.jpeg)![图片2-人物妆造正视图 (Token: OoMFbcfBEoiqkCxOQJpcjgcAnzQ)](images/OoMFbcfBEoiqkCxOQJpcjgcAnzQ.png)![图片3-人物妆造正视图 (Token: ZAs6bIUkQooRUBxxe2EcHDQ2nug)](images/ZAs6bIUkQooRUBxxe2EcHDQ2nug.png) | +| 输出内容 | | | | +| 总结 | åŒæ ·æ˜¯æ¸©é¦¨äº²å­å‰§æƒ…:左边输入内容包括:背景å‚考图ã€**人物妆造三视图ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…特写图**ã€æç¤ºè¯ï¼›ä¸­é—´è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯ï¼›å³è¾¹è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ æ­£é¢å›¾ã€æç¤ºè¯ã€‚左边的输出视频更加还原人物é¢éƒ¨ç‰¹å¾ï¼›ä¸­é—´çš„输出视频人物é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ï¼›å³è¾¹äººç‰©å¦†é€ ã€é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ã€‚ | | | + + + diff --git a/docs/API文档/3-31「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md b/docs/API文档/3-31「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md new file mode 100644 index 0000000..ee890ae --- /dev/null +++ b/docs/API文档/3-31「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md @@ -0,0 +1,1005 @@ +# 「⚠ï¸ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版) + +| **æ–‡æ¡£å˜æ›´è¯´æ˜Ž** | **æ—¶é—´** | +| ---------- | --------- | +| | 2026.3.26 | +| | 2026.3.28 | + +本文介ç»ç´ æèµ„产(Assets)API 接å£çš„傿•°ã€‚您å¯ä»¥ä½¿ç”¨ä»¥ä¸‹ Assets API 接å£åˆ›å»ºã€ç®¡ç†ä¸ªäººäººåƒç´ æèµ„产。 + +> 本文档仅é™é¢„览åŠé‚€æµ‹ç”¨æˆ·ä½¿ç”¨ï¼š +> +> * 䏿‰¿è¯ºæ­£å¼ API 上线100%一致。 +> +> * ä»…é™é‚€æµ‹ç”¨æˆ·é˜…读,请勿截图/分享给其他人员。 +> +> * 上传素æ (CreateAsset) API 为异步接å£ï¼Œç³»ç»Ÿå¤„ç†å¯èƒ½å‡ºçŽ°æŽ’é˜Ÿï¼Œå¯¼è‡´å…¥åº“æ—¶é—´å¢žåŠ ã€‚ä¸æ‰¿è¯ºä¸Šä¼ æ—¶é—´ SLA。 +> +> * ç´ æèµ„产应为虚拟人åƒï¼Œéžè™šæ‹Ÿäººåƒç±»ç´ ææ— éœ€å…¥åº“。 +> +> * 您需确ä¿ä¸Šä¼ çš„虚拟人åƒç¬¦åˆä»¥ä¸‹æ¡ä»¶ï¼š +> +> * æ‚¨åˆæ³•拥有该素æï¼Œå¹¶äº«æœ‰å®Œæ•´çš„使用åŠå¤„分æƒé™ã€‚ç´ æä¸åŒ…嫿œªèŽ·æŽˆæƒçš„ç¬¬ä¸‰æ–¹å•†æ ‡ã€æ ‡è¯†ç±»å†…容。 +> +> * ç´ æä¸å¾—ä¸Žä»»ä½•è‡ªç„¶äººè‚–åƒæˆ–形象雷åŒï¼Œç´ æä¸å­˜åœ¨æŠ„袭ã€ç›—用情形,ä¸ä¼šä¾µå®³ä»»ä½•第三方的人格æƒã€çŸ¥è¯†äº§æƒç­‰åˆæ³•æƒç›Šã€‚ +> +> * ç´ æä¸åŒ…å«è¿å法规ã€è¿èƒŒå…¬åºè‰¯ä¿—ã€å±å®³å›½å®¶å®‰å…¨çš„内容。 + + + +# ç´ æèµ„产库结构说明 + +* **Asset Group(素æèµ„产组åˆï¼‰**:å•ä¸ªç´ ææ–‡ä»¶ä¸ºä¸€ä¸ª Asset,æ¯ä¸ª Asset 属于一个 Asset Group。 + + * å¯ä»¥ä½¿ç”¨ç´ æç»„自由管ç†ç´ æï¼Œä¾‹å¦‚å¯å°†åŒä¸€è™šæ‹Ÿäººç‰©ç´ ææ”¾å…¥åŒä¸€ç´ æç»„åˆè¿›è¡Œç®¡ç†ã€‚ + +* **Asset(素æèµ„产)**ï¼šä¸€ä¸ªç´ ææ–‡ä»¶ï¼ˆå½“剿”¯æŒä¸Šä¼ å›¾åƒã€è§†é¢‘ã€éŸ³é¢‘),是方舟 Seedance 2.0 系列模型å¯ç›´æŽ¥ç”¨äºŽæŽ¨ç†çš„å¯ä¿¡èµ„产。 + +> æ³¨æ„ +> +> * 仅需入库推ç†éœ€ä½¿ç”¨çš„ç´ æèµ„产,ä¸éœ€ä½¿ç”¨çš„ç´ æèµ„产请勿入库。 +> +> * ä»…å¯ä½¿ç”¨å·²å…¥åº“ç´ æèµ„产的 Id (Asset ID) 进行视频生æˆï¼ŒåŒä¸€å½¢è±¡æœªå…¥åº“ç´ ææ— æ³•使用。 +> +> * æ¯ä¸ªä¸Šä¼ çš„ç´ æèµ„产需ç»è¿‡é¢„处ç†ï¼Œå¯è½®è¯¢è°ƒç”¨ **GetAsset** æŽ¥å£æŸ¥è¯¢ç´ æçжæ€ï¼ˆå¯¹åº”傿•°ä¸º **Status)**,仅当状æ€å˜ä¸º `Active` åŽï¼Œè¯¥ç´ æèµ„产方å¯ç”¨äºŽåŽç»­æŽ¨ç†ä½¿ç”¨ï¼›è‹¥çжæ€ä¸º `Failed` 则表示处ç†å¤±è´¥ï¼Œæ— æ³•用于åŽç»­æŽ¨ç†ä½¿ç”¨ã€‚**详情å¯å‚考:[上传素æèµ„产并获å–ç´ æèµ„产信æ¯ä»£ç ç¤ºä¾‹](https://bytedance.larkoffice.com/wiki/FtqVwjinYisraGkT5uncWyd0nEb#share-U55kdtSMVowUy9xkpJBcEazonpe)。** + + + +# ç´ æèµ„产(Assets)API 接å£åŠŸèƒ½ + +## **Asset (Group) 创建接å£ï¼š** + +1. CreateAssetGroup:创建素æèµ„产组åˆã€‚**首次创建素æèµ„äº§ç»„åˆæ—¶éœ€åœ¨æŽ§åˆ¶å°ç­¾ç½²æŽˆæƒå‡½ï¼Œè¯¦æƒ…å‚考 [ ç§åŸŸè™šæ‹Ÿäººåƒç´ æåº“ (WIP)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe)** + +2. CreateAsset:创建素æèµ„产。该接å£å¯ç”¨äºŽä¸Šä¼ ä¸ªäººç´ æèµ„产,创建素æèµ„产åŽå¯åˆ©ç”¨è¿”回字段中的素æ **Id (需处于 `Active` 状æ€ï¼‰**用于 Seedance 2.0 系列模型生æˆè§†é¢‘。 + + + +## **Asset (Group) ç®¡ç†æŽ¥å£ï¼š** + +* ListAssetGroups:查询素æèµ„产组åˆåˆ—表。 + +* ListAssets:查询素æèµ„产列表。 + +* GetAsset:查询素æèµ„产信æ¯ã€‚ + +* GetAssetGroup:查询素æèµ„产组åˆä¿¡æ¯ã€‚ + +* UpdateAssetGroup:更新素æèµ„产组åˆä¿¡æ¯ã€‚ + +* UpdateAsset:更新素æèµ„产信æ¯ã€‚ + +* DeleteAsset:删除å•个素æèµ„产。 + + + +# é‰´æƒæ–¹å¼ + +调用素æèµ„产(Assets)API 接å£éœ€ä½¿ç”¨ Access Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [èŽ·å– API 访问密钥(AK/SK)](https://www.volcengine.com/docs/6257/64983?lang=zh)。 + + + +# 陿µè¦æ±‚ + +* QPS 陿µï¼š APIæŽ¥å£æ¯ç§’查询请求的总数上é™ã€‚超过此é™åˆ¶çš„æŸ¥è¯¢è¯·æ±‚会报错。 + +| 接å£å | è´¦å·ç»´åº¦çš„ QPS 陿µ | +| ---------------- | ------------ | +| CreateAssetGroup | 30 | +| CreateAsset | 1 | +| ListAssetGroups | 30 | +| ListAssets | 30 | +| GetAsset | 100 | +| GetAssetGroup | 100 | +| UpdateAsset | 30 | +| UpdateAssetGroup | 30 | + +# CreateAssetGroup + +> **POST **/open/CreateAssetGroup + +创建 Asset Group(素æèµ„产组åˆï¼‰ç»„åˆï¼Œç”¨ä½œç´ æèµ„产管ç†ã€‚ + +> **首次创建 Asset Group(素æèµ„产组åˆï¼‰éœ€åœ¨æŽ§åˆ¶å°ç­¾ç½²æŽˆæƒå‡½ï¼Œè¯¦æƒ…å‚考 [ ç§åŸŸè™šæ‹Ÿäººåƒç´ æåº“ (WIP)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe)** + +## è¯·æ±‚å‚æ•° + +### **Name** `string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º 64 字符。 + +*** + +### **Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **GroupType **`string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +> 当å‰ä»…æ”¯æŒ AIGC 类型。 + + + +*** + +### **ProjectName **`string`** ** + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +返回示例: + + + +# CreateAsset + +> **POST **/open/CreateAsset + +呿Œ‡å®šçš„Asset Group(素æèµ„产组åˆï¼‰å†…创建Asset(素æèµ„产)。 + +> 上传素æ (CreateAsset) API 为异步接å£ï¼Œç³»ç»Ÿå¤„ç†å¯èƒ½å‡ºçŽ°æŽ’é˜Ÿï¼Œå¯¼è‡´å…¥åº“æ—¶é—´å¢žåŠ ã€‚ä¸æ‰¿è¯ºä¸Šä¼ æ—¶é—´ SLA。 + +## è¯·æ±‚å‚æ•° + +### **GroupId** `string` `å¿…å¡«` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **URL** `string` `å¿…å¡«` + +传入的Asset(素æèµ„产)的公共å¯è®¿é—®åœ°å€ã€‚ + +*** + +### **Name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +> 该字段仅用于使用 ListAssets æŽ¥å£æ—¶æ¨¡ç³Šæœç´¢ç´ æï¼Œä¸ä¼šè¢«å¸¦å…¥æ¨¡åž‹æŽ¨ç†ã€‚关于如何使用素æç”Ÿæˆè§†é¢‘,请å‚考[使用人åƒç´ æç”Ÿæˆè§†é¢‘](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe#share-QF2qdZE5HoRkRDxfs9bcmqECnDb)å’Œ[常è§é—®é¢˜ 4](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe#share-YOKvdYHjro8EjtxucWaczf6vneg)。 + +*** + +### **AssetType `string` `å¿…å¡«`** + +Asset(素æèµ„产)的类型,支æŒä¼ å…¥å›¾åƒã€éŸ³é¢‘ã€è§†é¢‘。å¯é€‰å€¼ï¼š + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +* Video:Asset(素æèµ„产)的类型为视频。 + +* Audio:Asset(素æèµ„产)的类型为音频。 + +> **传入图åƒã€éŸ³é¢‘ã€è§†é¢‘ç´ ææ—¶ï¼Œä»…支æŒä¸Šä¼  URL ï¼Œä¸æ”¯æŒ base64。** +> +> **ä¼ å…¥å•个图åƒè¦æ±‚** +> +> * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gifã€heic/heif +> +> * 宽高比(宽/高): (0.4, 2.5) +> +> * 宽高长度(px):(300, 6000) +> +> * 大å°ï¼šå•张图片å°äºŽ 30 MB +> +> **ä¼ å…¥å•ä¸ªè§†é¢‘è¦æ±‚** +> +> * æ ¼å¼ï¼šmp4ã€mov +> +> * 分辨率:480pã€720p +> +> * 时长:å•个视频时长 \[2, 15] s +> +> * 尺寸: +> +> * 宽高比(宽/高):\[0.4, 2.5] +> +> * 宽高长度(px):\[300, 6000] +> +> * 总åƒç´ æ•°ï¼š\[640×640=409600, 834×1112=927408],å³å®½å’Œé«˜çš„ä¹˜ç§¯ç¬¦åˆ \[409600, 927408] çš„åŒºé—´è¦æ±‚。 +> +> * 大å°ï¼šå•个视频ä¸è¶…过 50 MB +> +> * 帧率 (FPS):\[24, 60] +> +> **ä¼ å…¥å•ä¸ªéŸ³é¢‘è¦æ±‚** +> +> * æ ¼å¼ï¼šwavã€mp3 +> +> * 时长:å•个音频时长 \[2, 15] s +> +> * 大å°ï¼šå•个音频ä¸è¶…过 15 MB + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +> 需è¦å’Œå¾…传入的 Asset Group(素æèµ„产组åˆï¼‰çš„ **ProjectName **保æŒä¸€è‡´ã€‚ + +*** + + + +## è¿”å›žå‚æ•° + +### **Id **`string` + +Asset(素æèµ„产)的 Id。 + +*** + +返回示例: + + + +# ListAssets + +> **POST **/open/ListAssets + +查询符åˆç­›é€‰æ¡ä»¶çš„ Assets(素æèµ„产)列表。 + +## è¯·æ±‚å‚æ•° + +### **Filter** `object` `å¿…å¡«` + +æœç´¢çš„过滤æ¡ä»¶ã€‚ + +*** + +Filter.**GroupIds** `array` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Filter.**GroupType** `string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +*** + +Filter.**Statuses** `array`** ** + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +Filter.**Name** `string`** ** + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +### **PageNumber** `int (i64)` `å¿…å¡«` + +æœç´¢é¡µç ï¼Œå¯ç”¨äºŽåˆ—表分页功能,从 1 开始。例如:"page\_number": 1,å³è¿”回第一页的æœç´¢ç»“果。 + +*** + +### **PageSize** `int (i64)` `å¿…å¡«` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + +### **SortBy** `string` + +用于排åºçš„字段å称,默认值 `createTime`。支æŒä»¥ä¸‹ç±»åž‹ï¼š + +* CreateTime:根æ®åˆ›å»ºæ—¶é—´æŽ’åºã€‚ + +* UpdateTimeï¼šæ ¹æ®æ›´æ–°æ—¶é—´æŽ’åºã€‚ + +* GroupId:根æ®èµ„产素æç»„çš„ Id 排åºã€‚ + +*** + +### **SortOrder** `string` + +排åºé¡ºåºï¼Œé»˜è®¤å€¼ `Desc`。å¯é€‰å€¼ï¼š + +* Desc:é™åº + +* Asc:å‡åº + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Items** `array[]` + +符åˆç­›é€‰æ¡ä»¶çš„Asset(素æèµ„产)数组。 + +*** + +Items.**Id** `string` + +Asset(素æèµ„产)的 Id。 + +*** + +Items.**name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +Items.**URL** `string` + +Asset(素æèµ„产)的公共å¯è®¿é—®åœ°å€ã€‚有效期为12å°æ—¶ï¼Œè¯·åŠæ—¶ä¿å­˜ã€‚ + +*** + +Items.**GroupId** `string` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Items.**AssetType** `string` + +Asset(素æèµ„产)的类型,支æŒä¼ å…¥å›¾åƒã€éŸ³é¢‘ã€è§†é¢‘。支æŒç±»åž‹ï¼š + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +* Video:Asset(素æèµ„产)的类型为视频。 + +* Audio:Asset(素æèµ„产)的类型为音频。 + +*** + +Items.**Status** `string` + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +Items.**Error** `object` + +错误信æ¯ã€‚ + +*** + +Items.Error.**Code** `string` + +错误ç ã€‚ + +*** + +Items.Error.**Message** `string` + +错误信æ¯ã€‚ + +*** + +Items.**ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +Items.**CreateTime **`string` + +创建时间。 + +*** + +Items.**UpdateTime **`string` + +更新时间。 + +*** + +### **TotalCount **`int (i64)` + +返回总数。 + +*** + +### **PageNumber **`int (i64)` + +返回的页数。 + +*** + +### **PageSize **`int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + + + +# ListAssetGroups + +> **POST **/open/ListAssetGroups + +查询符åˆç­›é€‰æ¡ä»¶çš„Asset Groups(素æèµ„产组åˆï¼‰åˆ—表。 + +## è¯·æ±‚å‚æ•° + +### **Filter** `object` `å¿…å¡«` + +æœç´¢çš„过滤æ¡ä»¶ã€‚ + +*** + +Filter.**name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +Filter.**GroupIds** `array` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Filter.**GroupType** `string`** **`å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +*** + +### **PageNumber** `int (i64)` + +æœç´¢é¡µç ï¼Œå¯ç”¨äºŽåˆ—表分页功能,从 1 开始。例如:"page\_number": 1,å³è¿”回第一页的æœç´¢ç»“果。 + +*** + +### **PageSize** `int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + +### **SortBy** `string` + +用于排åºçš„字段å称,默认值 `createTime`。支æŒä»¥ä¸‹ç±»åž‹ï¼š + +* CreateTime:根æ®åˆ›å»ºæ—¶é—´æŽ’åºã€‚ + +* UpdateTimeï¼šæ ¹æ®æ›´æ–°æ—¶é—´æŽ’åºã€‚ + +*** + +### **SortOrder** `string` + +排åºé¡ºåºï¼Œé»˜è®¤å€¼ `Desc`。å¯é€‰å€¼ï¼š + +* Desc:é™åº + +* Asc:å‡åº + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **TotalCount **`int (i64)` + +返回的 Asset Group(素æèµ„产组åˆï¼‰çš„æ€»æ•°ã€‚ + +*** + +### **Items** `array[]` + +符åˆç­›é€‰æ¡ä»¶çš„ Asset Group(素æèµ„产组åˆï¼‰æ•°ç»„。 + +*** + +Items.**Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Items.**Name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +Items.**Title** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æ ‡é¢˜ã€‚ + +> å·²åºŸå¼ƒï¼Œè¯·ç›´æŽ¥ä½¿ç”¨å‚æ•° Name + +*** + +Items.**Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +Items.**GroupType** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。 + +* AIGC:虚拟人åƒã€‚ + +*** + +Items.**ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +Items.**CreateTime** `string` + +创建时间。 + +*** + +Items.**UpdateTime** `string` + +更新时间。 + +*** + +### **PageNumber **`int (i64)` + +返回的页数。 + +*** + +### **PageSize **`int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + + + +# GetAssetGroup + +> **POST **/open/GetAssetGroup + +获å–å•个Asset Group(素æèµ„产组åˆï¼‰ä¿¡æ¯ã€‚ + +## è¯·æ±‚å‚æ•° + + + +### **Id **`string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id + +*** + +### **ProjectName **`string` + +éœ€è¦æŸ¥è¯¢çš„ Asset Group(素æèµ„产组åˆï¼‰æ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **Name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +### **Title** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æ ‡é¢˜ã€‚ + +> å·²åºŸå¼ƒï¼Œè¯·ç›´æŽ¥ä½¿ç”¨å‚æ•° Name + +*** + +### **Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **GroupType **`string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。 + +* AIGCï¼šè™šæ‹Ÿäººåƒ + +*** + +### **ProjectName **`string`** ** + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +### **CreateTime **`string` + +创建时间。 + +*** + +### **UpdateTime **`string` + +更新时间。 + +*** + +## + +# GetAsset + +> **POST **/open/GetAsset + +获å–å•个Asset(素æèµ„产)信æ¯ã€‚ + +## è¯·æ±‚å‚æ•° + + + +### **Id **`string` `å¿…å¡«` + +Asset(素æèµ„产)的 Id。 + +*** + +### **ProjectName **`string` + +éœ€è¦æŸ¥è¯¢çš„ Asset(素æèµ„产)所属的项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id **`string` + +Asset(素æèµ„产)的 Id。 + +*** + +### **Name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +### **URL **`string` + +Asset(素æèµ„产)的访问地å€ã€‚有效期为12å°æ—¶ï¼Œè¯·åŠæ—¶ä¿å­˜ã€‚ + +*** + +### **AssetType **`string` + +Asset(素æèµ„产)的类型,支æŒä¼ å…¥å›¾åƒã€éŸ³é¢‘ã€è§†é¢‘。支æŒç±»åž‹ï¼š + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +* Video:Asset(素æèµ„产)的类型为视频。 + +* Audio:Asset(素æèµ„产)的类型为音频。 + +*** + +### **GroupId** `string` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **Status** `string` + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +### **Error** `object` + +错误信æ¯ã€‚ + +*** + +Error.**Code** `string` + +错误ç ã€‚ + +*** + +Error.**Message** `string` + +错误信æ¯ã€‚ + +*** + +### **CreateTime **`string` + +创建时间。 + +*** + +### **UpdateTime ** `string` + +更新时间。 + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +## + +# **UpdateAssetGroup** + +> **POST **/open/UpdateAssetGroup + +æ›´æ–°å•个 Asset Group(素æèµ„产组åˆï¼‰ä¿¡æ¯ã€‚当å‰ä»…æ”¯æŒæ›´æ–° Asset Group(素æèµ„产组åˆï¼‰çš„ Name å’Œ Description。 + +## è¯·æ±‚å‚æ•° + +### **Id **`string` `å¿…å¡«` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **Name **`string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„æ–°å称,上é™ä¸º64个字符。 + +*** + +### **Description** `string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„æ–°æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **ProjectName** `string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰æ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + + + + + +# **UpdateAsset** + +> **POST **/open/UpdateAsset + +æ›´æ–°å•个Asset(素æèµ„产)信æ¯ã€‚当å‰ä»…æ”¯æŒæ›´æ–°Asset(素æèµ„产)的 Name。 + +## è¯·æ±‚å‚æ•° + +### **Id **`string` `å¿…å¡«` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)的 Id。 + +*** + +### **Name **`string` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)的新å称,上é™ä¸º64个字符。 + +*** + +### **ProjectName** `string` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)所属的项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset(素æèµ„产)的 Id。 + +*** + + + +# **DeleteAsset** + +> **POST **/open/DeleteAsset + +删除å•个 Asset(素æèµ„产)。 + +## è¯·æ±‚å‚æ•° + +### **Id **`string` `å¿…å¡«` + +需è¦åˆ é™¤çš„ Asset(素æèµ„产)的 Id。 + +*** + +### **ProjectName** `string` + +需è¦åˆ é™¤çš„ Asset(素æèµ„产)所属的项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +æœ¬æŽ¥å£æ— è¿”å›žå‚æ•°ã€‚ + +*** + + + +# 代ç ç¤ºä¾‹ï¼š + +> **以下示例为使用 Asset API 创建素æèµ„产并用于视频生æˆçš„使用链路:** +> +> 1. **创建素æèµ„产组åˆï¼š**调用 **CreateAssetGroup** 接å£åˆ›å»ºä¸€ä¸ªç´ æèµ„产组åˆï¼ˆAsset Group),用于对åŒä¸€é¡¹ç›®æˆ–人物的素æè¿›è¡Œç»Ÿä¸€ç®¡ç†ã€‚首次创建时需在控制å°ç­¾ç½²æŽˆæƒå‡½ã€‚ +> +> 2. **上传素æèµ„产并等待预处ç†å®Œæˆï¼š**调用 **CreateAsset** 接å£ä¸Šä¼ å›¾ç‰‡/视频/音频素æï¼Œä¼ å…¥ç´ æçš„公共访问URLåŠæ‰€å±žçš„Group ID,获得素æèµ„产ID(Asset ID)。 +> 由于上传的素æèµ„产需ç»è¿‡é¢„处ç†åŽæ‰èƒ½ä½¿ç”¨ï¼Œå¯è½®è¯¢è°ƒç”¨ **GetAsset** æŽ¥å£æŸ¥è¯¢ç´ æçжæ€ï¼Œç›´è‡³çжæ€å˜ä¸º `Active`。若状æ€ä¸º `Failed` 则表示处ç†å¤±è´¥ï¼Œæ— æ³•用于åŽç»­æŽ¨ç†ä½¿ç”¨ã€‚ +> +> 3. **åœ¨è§†é¢‘ç”Ÿæˆ API 中使用素æï¼š**当ç´ æèµ„产状æ€ä¸º `Active` åŽï¼Œå°†ç´ æID按 `asset://`** çš„æ ¼å¼æ‹¼æŽ¥æˆURL,在视频生æˆAPI(如Seedance 2.0系列模型)的请求中,将该URL作为å‚考图片/视频/音频的 `image_url` 传入,å³å¯ä½¿ç”¨è¯¥ç´ æèµ„产生æˆè§†é¢‘。 +> +> **API é‰´æƒæ–¹å¼åŒºåˆ«è¯´æ˜Ž** +> +> * **Asset API:**Access Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [èŽ·å– API 访问密钥(AK/SK)](https://www.volcengine.com/docs/6257/64983?lang=zh)。 +> +> * **è§†é¢‘ç”Ÿæˆ API:**API Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [ç®¡ç† API Key](https://www.volcengine.com/docs/82379/1361424?lang=zh)。 +> +> **ç´ æåº“[项目](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)(Project)隔离说明** +> +> * 呿Œ‡å®šçš„ Asset Group(素æèµ„产组åˆï¼‰å†…创建或查询 Asset(素æèµ„产)时,需ä¿è¯ä¸¤è€…çš„ **ProjectName **一致 +> +> * Asset(素æèµ„产)所属的 **ProjectName** éœ€ä¸Žè°ƒç”¨è§†é¢‘ç”Ÿæˆ API æŽ¥å£æ—¶ä½¿ç”¨çš„ API key 所属的 **ProjectName** 一致 + +## 1. 创建素æèµ„äº§ç»„åˆ + +返回示例 + + + +## 2. 上传素æèµ„产并获å–ç´ æèµ„äº§ä¿¡æ¯ + +返回示例 + + + +更多语言的示例代ç è¯¦è§ï¼š + +> æ³¨æ„æ›¿æ¢ Demo 中的 AK与SK,若需调用其他接å£å¦‚ ListAssetsï¼Œéœ€æ›¿æ¢ ACTION ä¸Žå¯¹åº”è¯·æ±‚å‚æ•°ã€‚ + +| **Python** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产并获å–ç´ æèµ„产信æ¯ï¼š | +| ---------- | --------------------------- | +| **Java** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产并获å–ç´ æèµ„产信æ¯ï¼š | +| **PHP** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产: | + + + +## 3. ç´ æèµ„äº§ç”¨äºŽè§†é¢‘ç”Ÿæˆ + +> **注æ„:** +> 在传入给模型的 Prompt 中,需è¦ä½¿ç”¨**图片 1**ã€**视频 1 **的æ–¹å¼æŒ‡ä»£å‚考素æï¼Œç´ æåºå·ä¸ºç´ æåœ¨è¯·æ±‚体中的顺åºã€‚请勿直接在 Prompt 中直接使用 Asset ID。 +> 例:“**图片1 **里的女孩身ç€**图片2**中的æœè£…ï¼Œæ­£åœ¨æ•´ç†æŸœå°ä¸Šçš„物å“。**图片3**中的男孩是一ä½é¡¾å®¢ï¼Œä»–走上å‰ï¼Œæƒ³è¦å‘女孩索è¦è”系方å¼ã€‚†+> +> 调用示例请å‚考[常è§é—®é¢˜ 4](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe#share-YOKvdYHjro8EjtxucWaczf6vneg) + +当上传的素æèµ„产状æ€ä¸º `Active` 时,å¯å°†ç´ æ Id 按 `asset: //` 的规则拼接 URL,以在 **è§†é¢‘ç”Ÿæˆ API **中使用对应的素æèµ„产生æˆè§†é¢‘: + +使用素æèµ„产生æˆè§†é¢‘的具体调用方å¼è¯·å‚考[ ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版)](https://bytedance.larkoffice.com/wiki/SANpwJ9bgiKgrykLaMTcAB0InWc#share-ONSwd51ezoXCJqxkAm2cIC61nMX)。 + + + +# 最佳实践--ç§åŸŸç´ æèµ„产上传最佳案例 + +> 在上传素æèµ„产时,**若将目标人脸图ã€å…¨èº«å‚考图åŠç»†èŠ‚å‚考图åˆå¹¶ä¸ºåŒä¸€å¼ å›¾ç‰‡ï¼Œå¯èƒ½å¯¼è‡´å„å‚考元素在画é¢ä¸­å æ¯”较å°ï¼Œä»Žè€Œå¢žåŠ æ¨¡åž‹è¯†åˆ«éš¾åº¦**,造æˆç”Ÿæˆè§†é¢‘中的人物形象与所上传素æèµ„产出现å差,或造æˆç”Ÿæˆè§†é¢‘中素人脸被误识别为明星脸而触å‘风控拦截。 + +建议在上传素æèµ„产时,将人物é¢éƒ¨ç‰¹å†™ã€æœè£…细节等关键内容独立分割为å•独的图片进行上传。具体å¯å‚考如下规则åŠç¤ºä¾‹ï¼š + +| | 应该 | ä¸åº”该 | | +| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 输入内容 | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…ç‰¹å†™å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: BfvQbdPCDoJgGVx8x3zcMLoanHc)](images/BfvQbdPCDoJgGVx8x3zcMLoanHc.png)![图片2-人物妆造三视图 (Token: G0WaboKgVo3xo7xXxEGc8El6nLe)](images/G0WaboKgVo3xo7xXxEGc8El6nLe.png)![图片3-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: KIxBbnH6jonG19xgsqrcYkFEn7e)](images/KIxBbnH6jonG19xgsqrcYkFEn7e.png) | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: OnwKbbnpnojwcBxl1rucLDyQnJh)](images/OnwKbbnpnojwcBxl1rucLDyQnJh.png)![图片2-人物妆造三视图 (Token: ASc6b1QjJoi5owx1A9AccO0BnRd)](images/ASc6b1QjJoi5owx1A9AccO0BnRd.png) | | +| 输出内容 | | | | +| 总结 | åŒæ ·æ˜¯å¤é£Žæ‰“斗剧情:左边输入内容包括:背景å‚考图ã€**人物妆造三视图**ã€**人物é¢éƒ¨æ— è¡¨æƒ…特写图**ã€æç¤ºè¯ï¼›ä¸­é—´è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯ï¼›å³è¾¹è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ æ­£è§†å›¾ã€æç¤ºè¯ã€‚左边的输出视频更加还原人物é¢éƒ¨ç‰¹å¾ï¼›å³è¾¹çš„人物é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ã€‚ | | | +| 输入内容 | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…ç‰¹å†™å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: Y1ClbEmXPoKnp3xCV4MckLCWnQb)](images/Y1ClbEmXPoKnp3xCV4MckLCWnQb.jpeg)![图片2-人物妆造三视图 (Token: JYWCbGeXpo0QcgxFqQBcviGzn7b)](images/JYWCbGeXpo0QcgxFqQBcviGzn7b.jpeg)![图片3-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: Txwmbps9yoFd4ux6gOPcZoLEnkd)](images/Txwmbps9yoFd4ux6gOPcZoLEnkd.png)![图片4-人物妆造三视图 (Token: QDfrbDZLDo07MixPmPYcwGHLnjg)](images/QDfrbDZLDo07MixPmPYcwGHLnjg.jpeg)![图片5-人物é¢éƒ¨ç‰¹å†™å›¾ (Token: Jj0XbeEGxoxNXUx8X2Lcy7BFnab)](images/Jj0XbeEGxoxNXUx8X2Lcy7BFnab.jpeg) | 给出背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: IJLmbyIAHoNI7KxFYb7cfkrBn0f)](images/IJLmbyIAHoNI7KxFYb7cfkrBn0f.jpeg)![图片2-人物妆造三视图 (Token: Zq9xbc7pyo1K8gxKbocclO9ZnPb)](images/Zq9xbc7pyo1K8gxKbocclO9ZnPb.jpeg)![图片3-人物妆造三视图 (Token: G8l5b5qXKoqyB0xfQNDcVOMRn9b)](images/G8l5b5qXKoqyB0xfQNDcVOMRn9b.jpeg) | 给出背景å‚考图ã€äººç‰©å¦†é€ æ­£è§†å›¾ã€æç¤ºè¯![图片1-背景å‚考图 (Token: CcIPbldwjoacLuxErVUcJA5CnPe)](images/CcIPbldwjoacLuxErVUcJA5CnPe.jpeg)![图片2-人物妆造正视图 (Token: BPutbuFU7oeJkfxE3KkcuOQUnAh)](images/BPutbuFU7oeJkfxE3KkcuOQUnAh.png)![图片3-人物妆造正视图 (Token: PUR8bJ0g5o6VsAxWhqpcnS9vn4l)](images/PUR8bJ0g5o6VsAxWhqpcnS9vn4l.png) | +| 输出内容 | | | | +| 总结 | åŒæ ·æ˜¯æ¸©é¦¨äº²å­å‰§æƒ…:左边输入内容包括:背景å‚考图ã€**人物妆造三视图ã€äººç‰©é¢éƒ¨æ— è¡¨æƒ…特写图**ã€æç¤ºè¯ï¼›ä¸­é—´è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ ä¸‰è§†å›¾ã€æç¤ºè¯ï¼›å³è¾¹è¾“入内容包括:背景å‚考图ã€äººç‰©å¦†é€ æ­£é¢å›¾ã€æç¤ºè¯ã€‚左边的输出视频更加还原人物é¢éƒ¨ç‰¹å¾ï¼›ä¸­é—´çš„输出视频人物é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ï¼›å³è¾¹äººç‰©å¦†é€ ã€é¢éƒ¨ç‰¹å¾ä¸€è‡´æ€§éµå¾ªä¸ä½³ã€‚ | | | + diff --git a/docs/API文档/old-Seedance 2.0 & 2.0 fast API文档(邀测用户版).md b/docs/API文档/old-Seedance 2.0 & 2.0 fast API文档(邀测用户版).md new file mode 100644 index 0000000..969cf38 --- /dev/null +++ b/docs/API文档/old-Seedance 2.0 & 2.0 fast API文档(邀测用户版).md @@ -0,0 +1,692 @@ +# ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版) + +该文档目å‰ä»…é™å¼€ç™½å®¢æˆ·ä½¿ç”¨ï¼Œå‘é€å‰è¯·å’Œé”€ç®¡ç¡®è®¤å®¢æˆ·æ˜¯å¦åœ¨å¼€ç™½åå•内 + +***ã€â—ï¸â—ï¸â—ï¸ã€‘该文档é™åˆ¶å®¢æˆ·ç”³è¯·æƒé™ï¼Œåªæœ‰è¿”回了æœåŠ¡å议的客户方å¯ç”³è¯·*** + +æœ¬æ–‡ä»‹ç» Seedance 2.0 & 2.0 fast æ¨¡åž‹ç›¸è¾ƒäºŽå­˜é‡æ¨¡åž‹ **新增/é…置有区别 **的 API 傿•°ä»‹ç»ï¼Œå­˜é‡ API 傿•°çš„完整介ç»å‚è§ [è§†é¢‘ç”Ÿæˆ API](https://www.volcengine.com/docs/82379/1520758?lang=zh)。 + +> 本文档仅é™é¢„览åŠé‚€æµ‹ç”¨æˆ·ä½¿ç”¨ï¼š +> +> * 䏿‰¿è¯ºæ­£å¼API上线100%一致。 +> +> * ä»…é™é‚€æµ‹ç”¨æˆ·é˜…读,请勿截图/分享给其他人员。 +> +> * 您上传的内容请确ä¿ç”±æ‚¨åŽŸåˆ›æˆ–å·²å–得授æƒã€‚ + +# 模型能力 + +> **Seedance 2.0 å’Œ Seedance 2.0 fast æä¾›çš„æ¨¡åž‹èƒ½åŠ›ä¸€è‡´ï¼Œ**追求最高生æˆå“质,推è使用 **Seedance 2.0**ï¼›æ›´æ³¨é‡æˆæœ¬ä¸Žç”Ÿæˆé€Ÿåº¦ï¼Œä¸è¦æ±‚æžé™å“质,推è使用 **Seedance 2.0 fast**。 + +**Seedance 2.0 & 2.0 fast (有声视频/无声视频)** + +* **多模æ€å‚考生视频**:输入å‚考图片(0\~9)+å‚考视频(0\~3)+ å‚考音频(0\~3)+ 文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。支æŒç”Ÿæˆå…¨æ–°è§†é¢‘ã€ç¼–辑视频ã€å»¶é•¿è§†é¢‘。 + +> **注æ„:ä¸å¯å•ç‹¬è¾“å…¥éŸ³é¢‘ï¼Œåº”è‡³å°‘åŒ…å« 1 个å‚考视频或图片。** + +* **图生视频-首尾帧**:输入首帧图片+尾帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。 + +* **图生视频-首帧**:输入首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰ç”Ÿæˆ 1 个目标视频。 + +* **文生视频**:输入文本æç¤ºè¯ç”Ÿæˆ 1 个目标视频。 + + + +**模型能力对比表:** + +| 模型åç§° | | [Seedance 2.0](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-2-0) | [Seedance 2.0 fast](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-2-0-fast\&projectName=default) | [Seedance 1.5 pro](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-5-pro\&projectName=default) | [Seedance 1.0 pro ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-pro\&projectName=default) | [Seedance 1.0 pro fast ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-pro-fast\&projectName=default) | [Seedance 1.0 lite i2v](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-lite-i2v\&projectName=default) | [Seedance-1.0 lite t2v ](https://console.volcengine.com/ark/region:ark+cn-beijing/model/detail?Id=doubao-seedance-1-0-lite-t2v) | +| ------------ | -------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| Model ID | | doubao-seedance-2-0-260128 | doubao-seedance-2-0-fast-260128 | doubao-seedance-1-5-pro-251215 | doubao-seedance-1-0-pro-250528 | doubao-seedance-1-0-pro-fast-251015 | doubao-seedance-1-0-lite-i2v-250428 | doubao-seedance-1-0-lite-t2v-250428 | +| 文生视频 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 图生视频-首帧 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ⌠| +| 图生视频-首尾帧 | | ✅ | | ✅ | ✅ | ⌠| ✅ | ⌠| +| 多模æ€å‚考ã€New】 | 图片å‚考 | ✅ | | ⌠| ⌠| ⌠| ✅ | ⌠| +| | 视频å‚考 | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| | 组åˆå‚考 | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| 编辑视频ã€New】 | | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| 延长视频ã€New】 | | ✅ | | ⌠| ⌠| ⌠| ⌠| ⌠| +| ç”Ÿæˆæœ‰å£°è§†é¢‘ | | ✅ | | ✅ | ⌠| ⌠| ⌠| ⌠| +| è”网æœç´¢å¢žå¼ºã€New】 | | ✅ | | ⌠| [âŒ](https://p9-arcosite.byteimg.com/obj/tos-cn-i-goo7wpa0wc/f359753773c94d97885008ca1223c9bc) | ⌠| ⌠| ⌠| +| æ ·ç‰‡æ¨¡å¼ | | ⌠| | ✅ | ⌠| ⌠| ⌠| ⌠| +| 返回视频尾帧 | | ✅ | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 输出视频规格 | 输出分辨率 | 480p, 720p | | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | 480p, 720p, 1080p | +| | 输出宽高比 | 21:9, 16:9, 4:3, 1:1, 3:4, 9:16 | | | | | | | +| | 输出时长 | 4\~15 ç§’ | | 4\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | 2\~12 ç§’ | +| | è¾“å‡ºè§†é¢‘æ ¼å¼ | mp4 | | mp4 | mp4 | mp4 | mp4 | mp4 | +| ç¦»çº¿æŽ¨ç† | | [âŒ](https://p9-arcosite.byteimg.com/obj/tos-cn-i-goo7wpa0wc/f359753773c94d97885008ca1223c9bc) | | ✅ | ✅ | ✅ | ✅ | ✅ | +| 在线推ç†é™æµ | RPM | 600 | | 600 | 600 | 600 | 300 | 300 | +| | 并呿•° | 10 | | 10 | 10 | 10 | 5 | 5 | +| 离线推ç†é™æµ | TPD | - | | 5000亿 | 5000亿 | 5000亿 | 2500亿 | 2500亿 | + + + + + +# Creat-创建视频生æˆä»»åŠ¡ + +> POST https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks + +## è¯·æ±‚å‚æ•° + + + +#### **content** `object[]` `必选` + +输入给模型,生æˆè§†é¢‘的信æ¯ï¼Œæ”¯æŒæ–‡æœ¬ã€å›¾ç‰‡ã€éŸ³é¢‘ã€è§†é¢‘ã€æ ·ç‰‡ä»»åŠ¡ ID。支æŒä»¥ä¸‹å‡ ç§ç»„åˆï¼š + +* **文本** + +* **文本(å¯é€‰ï¼‰+ 图片** + +* **文本(å¯é€‰ï¼‰+ 视频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 音频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 视频** + +* **文本(å¯é€‰ï¼‰+ 视频 + 音频** + +* **文本(å¯é€‰ï¼‰+ 图片 + 视频 + 音频** + +*** + +**ä¿¡æ¯ç±»åž‹ï¼š** + +* **文本信æ¯**`object` + +输入给模型的æç¤ºè¯ä¿¡æ¯ã€‚ + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **text**。 + +*** + +content.**text **`string` `必选` + +输入给模型的文本æç¤ºè¯ï¼Œæè¿°æœŸæœ›ç”Ÿæˆçš„视频。 + +支æŒä¸­è‹±æ–‡ã€‚建议中文ä¸è¶…过500字,英文ä¸è¶…过1000è¯ã€‚字数过多信æ¯å®¹æ˜“分散,模型å¯èƒ½å› æ­¤å¿½ç•¥ç»†èŠ‚ï¼Œåªå…³æ³¨é‡ç‚¹ï¼Œé€ æˆè§†é¢‘缺失部分元素。æç¤ºè¯çš„æ›´å¤šä½¿ç”¨æŠ€å·§è¯·å‚è§ [Seedance æç¤ºè¯æŒ‡å—](https://www.volcengine.com/docs/82379/1587797)。 + + + + + +* **图片信æ¯** `object` + +输入给模型的图片信æ¯ã€‚ + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **image\_url**。 + +*** + +content.**image\_url **`object` `必选` + +输入给模型的图片对象。 + +*** + +content.image\_url.**url **`string` `必选` + +图片 URL ã€å›¾ç‰‡ Base64 ç¼–ç ã€ç´ æ ID。 + +* 图片 URL:填入图片的公网 URL。 + +* Base64 ç¼–ç ï¼šå°†æœ¬åœ°æ–‡ä»¶è½¬æ¢ä¸º Base64 ç¼–ç å­—ç¬¦ä¸²ï¼Œç„¶åŽæäº¤ç»™å¤§æ¨¡åž‹ã€‚éµå¾ªæ ¼å¼ï¼šdata:image/<图片格å¼>;base64,\ï¼Œæ³¨æ„ <图片格å¼> 需å°å†™ï¼Œå¦‚ data:image/png;base64,{base64\_image}。 + +* ç´ æ ID:用于视频生æˆçš„预置素æåŠè™šæ‹Ÿäººåƒçš„ ID,éµå¾ªæ ¼å¼ï¼šasset://\,å¯ä»Ž [ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128) 获å–,详细使用请å‚è§[文档](https://www.volcengine.com/docs/82379/2223965?lang=zh)。 + +> **ä¼ å…¥å•å¼ å›¾ç‰‡è¦æ±‚** +> +> * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gif +> +> * 宽高比(宽/高): (0.4, 2.5) +> +> * 宽高长度(px):(300, 6000) +> +> * 大å°ï¼šå•张图片å°äºŽ 30 MB。请求体大å°ä¸è¶…过 64 MB。大文件请勿使用Base64ç¼–ç ã€‚ +> +> * 图片数é‡ï¼š +> +> * 图生视频-首帧:1 å¼  +> +> * 图生视频-首尾帧:2 å¼  +> +> * Seedance 2.0 & 2.0 fast 多模æ€å‚考生视频:1\~9 å¼  + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +图片的ä½ç½®æˆ–用途。 + +> **注æ„** +> +> * **图生视频-首帧**ã€**图生视频-首尾帧**ã€**多模æ€å‚考生视频**(包括å‚考图ã€è§†é¢‘ã€éŸ³é¢‘)为 3 ç§äº’斥场景,**ä¸å¯æ··ç”¨**。 +> +> * **多模æ€å‚考生视频**å¯é€šè¿‡æç¤ºè¯æŒ‡å®šå‚考图片作为首帧/尾帧,间接实现“首尾帧+多模æ€å‚è€ƒâ€æ•ˆæžœã€‚若需严格ä¿éšœé¦–尾帧和指定图片一致,**优先使用图生视频-首尾帧**(é…ç½® role 为 **first\_frame / last\_frame**)。 + +*** + +**图生视频-首帧** + +> 需è¦ä¼ å…¥1个 image\_url 对象 + +* **字段roleå–值:** + + * **first\_frame 或ä¸å¡«** + +*** + +**图生视频-首尾帧** + +> 需è¦ä¼ å…¥2个 image\_url 对象 + +* **字段roleå–值:** + + * 首帧图片对应的字段 role 为:**first\_frame**,必填 + + * 尾帧图片对应的字段 role 为:**last\_frame**,必填 + +*** + +**图生视频-å‚考图 ** + +> å¯ä¼ å…¥ 1\~9 个 image\_url 对象 + +* **字段roleå–值**: + + * æ¯å¼ å‚考图对应的字段 role å‡ä¸ºï¼š**reference\_image**,必填 + + + + + +* **视频信æ¯** `object` + +输入给模型的视频信æ¯ã€‚ä»… Seedance 2.0 & 2.0 fast 支æŒè¾“入视频。 + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **video\_url**。 + +*** + +content.**video\_url **`object` `必选` + +输入给模型的视频对象。 + +*** + +content.video\_url.**url **`string` `必选` + +视频URLã€ç´ æ ID。 + +* 视频 URL:填入视频的公网 URL。 + +* ç´ æ ID:用于视频生æˆçš„预置素æåŠè™šæ‹Ÿäººåƒè§†é¢‘çš„ ID,éµå¾ªæ ¼å¼ï¼šasset://\。å¯ä»Ž[ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获å–。 + +> **ä¼ å…¥å•ä¸ªè§†é¢‘è¦æ±‚** +> +> * 视频格å¼ï¼šmp4ã€mov。 +> +> * 分辨率:480pã€720p +> +> * 时长:å•个视频时长 \[2, 15] s,最多传入 3 个å‚考视频,所有视频总时长ä¸è¶…过 15s。 +> +> * 尺寸: +> +> * 宽高比(宽/高):\[0.4, 2.5] +> +> * 宽高长度(px):\[300, 6000] +> +> * ç”»é¢åƒç´ ï¼ˆå®½ × 高):\[409600, 927408] ,示例: +> +> * ç”»é¢å°ºå¯¸ 640×640=409600 满足最å°å€¼ ï¼› +> +> * ç”»é¢å°ºå¯¸ 834×1112=927408 满足最大值。 +> +> * 大å°ï¼šå•个视频ä¸è¶…过 50 MB。 +> +> * 帧率 (FPS):\[24, 60] + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +视频的ä½ç½®æˆ–用途。当å‰ä»…æ”¯æŒ **reference\_video**。 + + + + + +* **éŸ³é¢‘ä¿¡æ¯ **`object` + +输入给模型的音频信æ¯ã€‚ä»… Seedance 2.0 & 2.0 fast 支æŒè¾“入音频。注æ„ä¸å¯å•ç‹¬è¾“å…¥éŸ³é¢‘ï¼Œåº”è‡³å°‘åŒ…å« 1 个å‚考视频或图片。 + +*** + +content.**type **`string` `必选` + +输入内容的类型,此处应为 **audio\_url**。 + +*** + +content.**audio\_url **`object` `必选` + +输入给模型的音频对象。 + +*** + +content.audio\_url.**url **`string` `必选` + +音频 URL ã€éŸ³é¢‘ Base64 ç¼–ç ã€ç´ æ ID。 + +* 音频 URL:填入音频的公网 URL。 + +* Base64 ç¼–ç ï¼šå°†æœ¬åœ°æ–‡ä»¶è½¬æ¢ä¸º Base64 ç¼–ç å­—ç¬¦ä¸²ï¼Œç„¶åŽæäº¤ç»™å¤§æ¨¡åž‹ã€‚éµå¾ªæ ¼å¼ï¼šdata:audio/<音频格å¼>;base64,\ï¼Œæ³¨æ„ <音频格å¼> 需å°å†™ï¼Œå¦‚ data:audio/wav;base64,{base64\_audio}。 + +* ç´ æ ID:用于视频生æˆçš„虚拟人的音频素æ ID,éµå¾ªæ ¼å¼ï¼šasset://\。å¯ä»Ž[ç´ æ&虚拟人åƒåº“](https://console.volcengine.com/ark-stg/region:ark-stg+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获å–。 + +> **ä¼ å…¥å•ä¸ªéŸ³é¢‘è¦æ±‚** +> +> * æ ¼å¼ï¼šwavã€mp3 +> +> * 时长:å•个音频时长 \[2, 15] s,最多传入 3 段å‚考音频,所有音频总时长ä¸è¶…过 15 s。 +> +> * 大å°ï¼šå•个音频ä¸è¶…过 15 MB,请求体大å°ä¸è¶…过 64 MB。大文件请勿使用Base64ç¼–ç ã€‚ + +*** + +content.**role **`string` `æ¡ä»¶å¿…å¡«` + +音频的ä½ç½®æˆ–用途。当å‰ä»…æ”¯æŒ **reference\_audio** 。 + + + +#### **service\_tier** `string` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **generate\_audio **`boolean` + +> Seedance 2.0 & 2.0 fast 默认值: true + +控制生æˆçš„视频是å¦åŒ…å«ä¸Žç”»é¢åŒæ­¥çš„声音。 + +* true:模型输出的视频包å«åŒæ­¥éŸ³é¢‘。模型会基于文本æç¤ºè¯ä¸Žè§†è§‰å†…容,自动生æˆä¸Žä¹‹åŒ¹é…的人声ã€éŸ³æ•ˆåŠèƒŒæ™¯éŸ³ä¹ã€‚建议将对è¯éƒ¨åˆ†ç½®äºŽåŒå¼•å·å†…ï¼Œä»¥ä¼˜åŒ–éŸ³é¢‘ç”Ÿæˆæ•ˆæžœã€‚例如:男人å«ä½å¥³äººè¯´ï¼šâ€œä½ è®°ä½ï¼Œä»¥åŽä¸å¯ä»¥ç”¨æ‰‹æŒ‡æŒ‡æœˆäº®ã€‚†+ +* false:模型输出的视频为无声视频。 + +> **说明** +> +> 生æˆçš„æœ‰å£°è§†é¢‘å‡ä¸ºå•声é“ï¼Œå’Œä¼ å…¥çš„éŸ³é¢‘å£°é“æ•°æ— å…³ã€‚ + +#### + +#### **draft **`boolean` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **tools **`object[]` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +é…置模型è¦è°ƒç”¨çš„工具。 + +*** + +tools.**type **`string` + +指定使用的工具类型。 + +* web\_search:è”网æœç´¢å·¥å…·ã€‚ + +> **说明** +> +> * å¼€å¯è”网æœç´¢åŽï¼Œæ¨¡åž‹ä¼šæ ¹æ®ç”¨æˆ·çš„æç¤ºè¯è‡ªä¸»åˆ¤æ–­æ˜¯å¦æœç´¢äº’è”网内容(如商å“ã€å¤©æ°”ç­‰ï¼‰ã€‚å¯æå‡ç”Ÿæˆè§†é¢‘的时效性,但也会增加一定的时延。 +> +> * 实际æœç´¢æ¬¡æ•°å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 usage.tool\_usage.**web\_search** 字段获å–,如果为 0 表示未æœç´¢ã€‚ + + + +#### **resolution ** `string` + +> Seedance 2.0 & 2.0 fast 默认值:720p + +视频分辨率,å–值范围: + +* 480p + +* 720p + + + +#### **ratio **`string` + +> Seedance 2.0 & 2.0 fast 默认值: adaptive + +生æˆè§†é¢‘的宽高比例。ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼è§ä¸‹æ–¹è¡¨æ ¼ã€‚ + +* 16:9 + +* 4:3 + +* 1:1 + +* 3:4 + +* 9:16 + +* 21:9 + +* adaptive:根æ®è¾“入自动选择最åˆé€‚的宽高比 + +> **adaptive 适é…规则** +> +> 当é…ç½® **ratio** 为 adaptive 时,模型会根æ®ç”Ÿæˆåœºæ™¯è‡ªåЍ适é…宽高比;实际生æˆçš„视频宽高比å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **ratio** 字段获å–。 +> +> * 文生视频:根æ®è¾“入的æç¤ºè¯ï¼Œæ™ºèƒ½é€‰æ‹©æœ€åˆé€‚的宽高比。 +> +> * 首帧 / 首尾帧生视频:根æ®ä¸Šä¼ çš„首帧图片比例,自动选择最接近的宽高比。 +> +> * 多模æ€å‚考生视频:根æ®ç”¨æˆ·æç¤ºè¯æ„图判断,如果是首帧生视频/编辑视频/延长视频,以该图片/视频为准选择最接近的宽高比;å¦åˆ™ï¼Œä»¥ä¼ å…¥çš„第一个媒体文件为准(优先级:视频>图片)选择最接近的宽高比。 + +*** + +**ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼ï¼š** + +| 分辨率 | 宽高比 | 宽高åƒç´ å€¼ | +| ---- | ---- | -------- | +| 480p | 16:9 | 864×496 | +| | 4:3 | 752×560 | +| | 1:1 | 640×640 | +| | 3:4 | 560×752 | +| | 9:16 | 496×864 | +| | 21:9 | 992×432 | +| 720p | 16:9 | 1280×720 | +| | 4:3 | 1112×834 | +| | 1:1 | 960×960 | +| | 3:4 | 834×1112 | +| | 9:16 | 720×1280 | +| | 21:9 | 1470×630 | + + + +#### **duration** `integer` + +> Seedance 2.0 & 2.0 fast 默认值:5 + +生æˆè§†é¢‘æ—¶é•¿ï¼Œä»…æ”¯æŒæ•´æ•°ï¼Œå•ä½ï¼šç§’。 + +å–值范围: + +* \[4,15] 或设置为-1 + +> **é…置方法** +> +> * æŒ‡å®šå…·ä½“æ—¶é•¿ï¼šæ”¯æŒæœ‰æ•ˆèŒƒå›´å†…的任一整数。 +> +> * 智能指定:设置为 -1,表示由模型在有效范围内自主选择åˆé€‚的视频长度(整数秒)。实际生æˆè§†é¢‘的时长å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **duration** 字段获å–。注æ„视频时长与计费相关,请谨慎设置。 + + + +#### **frames** `integer` + +Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +#### **camera\_fixed** `boolean` + + Seedance 2.0 & 2.0 fast æš‚ä¸æ”¯æŒ + + + +# Get/List-查询视频生æˆä»»åŠ¡/列表 + +> 查询视频生æˆä»»åŠ¡ï¼šGET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks/{id} +> +> 查询视频生æˆä»»åŠ¡åˆ—è¡¨ï¼šGET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks?page\_num={page\_num}\&page\_size={page\_size}\&filter.status={filter.status}\&filter.task\_ids={filter.task\_ids}\&filter.model={filter.model} + +## å“åº”å‚æ•° + +#### **tools **`object[]` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +é…置模型è¦è°ƒç”¨çš„工具。 + +*** + +tools.**type **`string` + +指定使用的工具类型。 + +* web\_search:è”网æœç´¢å·¥å…·ã€‚ + + + +#### **usage** `object` + +本次请求的 token 用é‡ã€‚ + +*** + +usage.**completion\_tokens** `integer` + +模型输出视频花费的 token æ•°é‡ã€‚ + +*** + +usage.**total\_tokens** `integer` + +本次请求消耗的总 token æ•°é‡ã€‚ + +*** + +usage.**tool\_usage **`object` + +> ä»… Seedance 2.0 & 2.0 fast æ”¯æŒ + +使用工具的用é‡ä¿¡æ¯ã€‚ + +*** + +usage.tool\_usage.**web\_search **`integer` + +实际调用è”网æœç´¢å·¥å…·çš„æ¬¡æ•°ï¼Œä»…å¼€å¯è”网æœç´¢æ—¶è¿”回。 + + + +# 调用简介åŠç¤ºä¾‹ + +## æµç¨‹ç®€ä»‹ + +ä»»åŠ¡æŽ¥å£æ˜¯å¼‚步接å£ï¼Œè§†é¢‘生æˆä»»åŠ¡æµç¨‹ + +1. 创建视频生æˆä»»åŠ¡æŽ¥å£åˆ›å»ºè§†é¢‘生æˆä»»åŠ¡ + +2. å®šæ—¶ä½¿ç”¨æŸ¥è¯¢æŽ¥å£æŸ¥è¯¢è§†é¢‘生æˆä»»åŠ¡çŠ¶æ€ + + 1. 任务 runningï¼Œè¿‡æ®µæ—¶é—´å†æŸ¥è¯¢ä»»åŠ¡çŠ¶æ€ + + 2. 任务完æˆï¼Œè¿”回视频链接,在24å°æ—¶å†…下载生æˆçš„视频文件 + +## 1. 创建视频生æˆä»»åŠ¡ + +> 以下示例仅展示 Seedance 2.0 & 2.0 fast 新增能力,更多视频生æˆç¤ºä¾‹è¯¦è§ [创建视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1520757)。 + +### 多模æ€å‚考 + +### 编辑视频 + +### 延长视频 + +### 使用è”网æœç´¢ + +ä»…æ”¯æŒæ–‡æœ¬ç”Ÿè§†é¢‘ + +## 2. 查询视频生æˆä»»åŠ¡ + +# 最佳实践-使用公共虚拟人åƒç”Ÿæˆè§†é¢‘ + +å¹³å°æä¾›å…¬å…±è™šæ‹Ÿäººåƒç´ æåº“ï¼Œç›®å‰æ‚¨å¯ä»¥ä½¿ç”¨å…¶ä¸­çš„图åƒç´ ææ¥åˆ›å»ºä¸€ä¸ªç»Ÿä¸€ã€å®Œå¤‡çš„视频主角。帮助您更好地控制主角,并确ä¿å…¶å½¢è±¡åœ¨å¤šæ®µè§†é¢‘ä¸­ä¿æŒä¸€è‡´ï¼Œé¿å…因为真人人脸é™åˆ¶å¯¼è‡´è§’色无法统一的问题。 + +ç´ ææ¨¡æ€ç›®å‰åŒ…å«å›¾ç‰‡ï¼Œå¹¶æä¾›äººç‰©èƒŒæ™¯æè¿°ã€‚æ¯ä¸ªç´ æå¯¹åº”一个独立素æ ID (asset ID),在体验中心的视频生æˆä»»åŠ¡ä¸­ï¼ŒæŒ‡å®šè§’è‰²äººè„¸ç”Ÿæˆè§†é¢‘。 + +1. 在æµè§ˆå™¨ä¸­æ‰“å¼€[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo),点击输入框下方的 **虚拟人åƒåº“** 页签。 + +2. 检索需è¦ä½¿ç”¨çš„人åƒï¼Œæ”¯æŒä½¿ç”¨è‡ªç„¶è¯­è¨€æ£€ç´¢åŠç­›é€‰æ¡†ç»„åˆç­›é€‰ã€‚ + +| 输入:文本 | 输入:虚拟人åƒã€å›¾ç‰‡ | 输出 | +| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -- | +| **图片1**中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒ**图片2**çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。 | ![Image Token: HTf6bPRukoWaW4xnCSlcvKtUn7c](images/HTf6bPRukoWaW4xnCSlcvKtUn7c.png)![Image Token: YfCDbzJlqo4yzZxCmdscWdsInCf](images/YfCDbzJlqo4yzZxCmdscWdsInCf.jpeg) | | + + + +在 [Video Generation API](https://www.volcengine.com/docs/82379/1520758) çš„ **content.<模æ€>\_url.url** 字段中使用 ç´ æ URI 生æˆè§†é¢‘。 + +> 输入的å‚考内容,包括人åƒç´ æï¼Œéœ€ç¬¦åˆè§†é¢‘生æˆé™åˆ¶ï¼Œå…·ä½“ä¿¡æ¯è¯·æŸ¥çœ‹ä½¿ç”¨é™åˆ¶ã€‚ +> +> **注æ„**: +> +> * 首次在 API 中使用虚拟人åƒç´ æ Asset URI å‰ï¼Œéœ€å…ˆåœ¨[方舟体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo)æäº¤ä¸€æ¬¡è§†é¢‘生æˆä»»åŠ¡ï¼Œé˜…è¯»å¹¶åŒæ„弹出的 **虚拟人åƒåº“使用åè®®**。 +> +> * 体验中心支æŒä½“验视频生æˆèƒ½åŠ›ã€‚é»˜è®¤å•æ¬¡ç”Ÿæˆ 4 æ®µè§†é¢‘ï¼Œä¸ºèŠ‚çº¦æˆæœ¬ï¼Œå»ºè®®è®¾ç½®ä¸ºæ¯æ¬¡ç”Ÿæˆ 1 æ¡ï¼Œå…·ä½“æ–¹å¼å¯å‚考[虚拟人åƒåº“](https://www.volcengine.com/docs/82379/2223965?lang=zh)。 + +åŒæ„å议的æ“作方å¼å¦‚下: + +![Image Token: LK8ybUN9Ko2KkQxq2FdclVQtnkh](images/LK8ybUN9Ko2KkQxq2FdclVQtnkh.gif) + +示例代ç ï¼š + +# 使用自有虚拟人åƒç´ æç”Ÿæˆè§†é¢‘(线下æäº¤ï¼‰ + +方舟æä¾›ç§åŸŸäººåƒç´ æåº“,您å¯åœ¨è§†é¢‘生æˆä¸­ä½¿ç”¨è‡ªæœ‰è™šæ‹Ÿäººç‰©æˆ–真人(仅é™ç´ äººï¼‰ç´ æï¼Œç”ŸæˆçŸ­å‰§ç­‰æ›´å®šåˆ¶åŒ–的视频内容。平å°å°†å¯¹æ‚¨æä¾›çš„ç´ æè¿›è¡Œå®¡æ ¸ï¼Œè§„é¿å¯èƒ½äº§ç”Ÿçš„æ³•律风险。 + +* 自有素æéœ€å…¥åº“åŽä½¿ç”¨ï¼Œæ‚¨å¯å°†è™šæ‹Ÿäººåƒæˆ–真人素æå‘é€ç»™é”€å”®ä»£è¡¨ï¼ŒåŒæ—¶å®Œæˆåˆè§„承诺函åŠå…¶ä»–è¯æ˜Žææ–™çš„准备。 + +* 入库åŽï¼Œæ‚¨å¯ä½¿ç”¨ç´ æçš„ Asset IDï¼Œåœ¨è§†é¢‘ç”Ÿæˆ API 中使用自有素æã€‚ + +> **é‡è¦**: +> +> * 对虚拟人åƒç´ æï¼Œæ‚¨éœ€ç­¾ç½²è™šæ‹Ÿäººåƒç´ æåˆè§„承诺函,并æä¾›ç­¾ç½²æ‰¿è¯ºå‡½æ‰€éœ€çš„ææ–™ã€‚ +> +> * 对真实人物素æï¼Œé™¤æ‰¿è¯ºå‡½å¤–,您还需é¢å¤–æä¾›çœŸäººæŽˆæƒææ–™ã€‚ +> +> * 具体æµç¨‹åŠæ‰€éœ€ææ–™ï¼Œè¯·å’Œæ‚¨çš„销售代表确认。 + +æäº¤è‡ªæœ‰äººåƒç´ ææ—¶ï¼Œéœ€æŒ‰äººç‰©å°†ç´ æåˆ†ç»„: + +* æ¯ä¸ªäººç‰©ä¸ºä¸€ä¸ªç´ æç»„。 + +* æ¯ç»„å¯åŒ…å«å¤šä¸ªç´ ææ–‡ä»¶ï¼Œç´ ææ–‡ä»¶å¯¹åº”唯一 ID (asset ID)。 + +## 入库æµç¨‹ + +æäº¤è‡ªæœ‰è™šæ‹Ÿäººåƒç´ ææ–¹å¼å¤§è‡´å¦‚下,请è”系您的销售代表了解详情。 + +1. å‡†å¤‡ç´ ææ–‡ä»¶ï¼Œå®Œæˆæ‰¿è¯ºå‡½ç­¾ç½²ï¼Œå¹¶å‡†å¤‡å…¶ä»–è¯æ˜Žææ–™ã€‚ + +2. å‡†å¤‡ç´ ææ–‡ä»¶ï¼Œå®Œæˆæ‰¿è¯ºå‡½ç­¾ç½²ï¼Œå¹¶å‡†å¤‡å…¶ä»–è¯æ˜Žææ–™ã€‚ + + * æ¯ä¸ªäººç‰©ç´ æéœ€è‡³å°‘æä¾›ä¸€å¼ æ­£é¢å›¾ç‰‡æ–‡ä»¶ã€‚æ­¤å¤–ï¼Œæ‚¨å¯æŒ‰éœ€æä¾›è¯¥äººç‰©çš„其他图片ã€è§†é¢‘ç´ æã€‚ + + * éœ€ç¡®ä¿æ¯ä¸ªäººç‰©ç»„中的素æä¸Žè¯¥æ­£é¢å›¾ç‰‡ä¸ºåŒä¸€äººç‰©ã€‚ + + * æ¯ä¸ªäººç‰©åˆ›å»ºä¸€ä¸ªæ–‡ä»¶å¤¹ï¼ˆå‘½å:“*è™šæ‹Ÿäººåƒ 1-<人åƒå>*â€ï¼‰ + + æäº¤ç´ ææ–‡ä»¶å¤¹ç¤ºä¾‹ï¼š + + ![Image Token: XMQ9bz6vhof7vxxsac8cqIZmneB](images/XMQ9bz6vhof7vxxsac8cqIZmneB.png) + + > **注æ„**: + > + > * 以上示例仅供å‚è€ƒï¼Œæ‚¨å¯æ ¹æ®è§†é¢‘创作需求,æäº¤è™šæ‹Ÿäººç‰©ç´ æã€‚ + > + > * 您仅需上传视频生æˆä»»åŠ¡ä¸­éœ€è¦ä½¿ç”¨çš„ç´ æã€‚ + + * ç´ ææ–‡ä»¶éœ€æ»¡è¶³è§†é¢‘ç”Ÿæˆ API å¯¹è¾“å…¥æ–‡ä»¶çš„è¦æ±‚: + + > **ä¼ å…¥å•å¼ å›¾ç‰‡è¦æ±‚** + > + > * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gif + > + > * 宽高比(宽/高): (0.4, 2.5) + > + > * 宽高长度(px):(300, 6000) + > + > * 大å°ï¼šå•张图片å°äºŽ 30 MB。请求体大å°ä¸è¶…过 64 MB。大文件请勿使用Base64ç¼–ç ã€‚ + + + + > **ä¼ å…¥å•ä¸ªè§†é¢‘è¦æ±‚** + > + > * 视频格å¼ï¼šmp4ã€mov。 + > + > * 分辨率:480pã€720p + > + > * 时长:å•个视频时长 \[2, 15] s,最多传入 3 个å‚考视频,所有视频总时长ä¸è¶…过 15s。 + > + > * 尺寸: + > + > * 宽高比(宽/高):\[0.4, 2.5] + > + > * 宽高长度(px):\[300, 6000] + > + > * ç”»é¢åƒç´ ï¼ˆå®½ × 高):\[409600, 927408] ,示例: + > + > * ç”»é¢å°ºå¯¸ 640×640=409600 满足最å°å€¼ ï¼› + > + > * ç”»é¢å°ºå¯¸ 834×1112=927408 满足最大值。 + > + > * 大å°ï¼šå•个视频ä¸è¶…过 50 MB。 + > + > * 帧率 (FPS):\[24, 60] + + + + > **注æ„**: + > + > 有关æäº¤æµç¨‹ã€æ‰¿è¯ºå‡½ç­¾ç½²æ‰€éœ€ææ–™çš„具体信æ¯ï¼Œè¯·è”系您的销售代表了解详情。 + +3. 方舟将对您æä¾›çš„ç´ æè¿›è¡Œå®¡æ ¸ï¼Œé€šè¿‡å®¡æ ¸çš„ç´ æå°†è¢«ä¸Šä¼ è‡³è™šæ‹Ÿäººåƒåº“。 + +4. 入库åŽï¼Œæ¯ä¸ªäººç‰©ç»„ç´ æå°†é€šè¿‡ä»¥ä¸‹ç¤ºä¾‹ä¸­çš„å½¢å¼è¿”回,您å¯è§£åŽ‹åŽæŸ¥çœ‹ï¼š + + ![Image Token: PKu6b3391oUbVKxxEGjchxBVnbg](images/PKu6b3391oUbVKxxEGjchxBVnbg.png) + +示例中: + +* Andy 为您æäº¤çš„人物åç§° + +* group-20260310035119-9mzqn 为该人物组的 ID + +* 解压åŽï¼Œå¯æŸ¥çœ‹æ¯å¼ ç´ æçš„ Asset ID,如: + +![Image Token: VV0ybrxNfouEhZxTjqCcX1epnzb](images/VV0ybrxNfouEhZxTjqCcX1epnzb.png) + +* æ‚¨å¯æŒ‰ `asset: //` 规则拼接 URI,在 API 中使用对应素æç”Ÿæˆè§†é¢‘: + +具体调用方å¼è¯·å‚考 [最佳实践-使用虚拟人åƒç”Ÿæˆè§†é¢‘](https://bytedance.larkoffice.com/wiki/SANpwJ9bgiKgrykLaMTcAB0InWc#share-YurKdrLfAocLErxsTWDcKidPnGd)。 + +## **注æ„事项** + +1. 首次在 API 中使用虚拟人åƒç´ æ Asset URI å‰ï¼Œéœ€å…ˆåœ¨[方舟体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo)æäº¤ä¸€æ¬¡è§†é¢‘生æˆä»»åŠ¡ï¼Œé˜…è¯»å¹¶åŒæ„弹出的 **虚拟人åƒåº“使用åè®®**,æ“作方å¼å¦‚下: + +![Image Token: IFfPbDgceoFXZCxdriIcnwkPnUc](images/IFfPbDgceoFXZCxdriIcnwkPnUc.gif) + +* 仅支æŒä½¿ç”¨å·²å…¥åº“ç´ æç”Ÿæˆè§†é¢‘。 diff --git a/docs/API文档/old-「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md b/docs/API文档/old-「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md new file mode 100644 index 0000000..75cb4f3 --- /dev/null +++ b/docs/API文档/old-「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版).md @@ -0,0 +1,1201 @@ +# 「⚠ï¸ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Assets API å‚考文档(邀测用户版) + +本文介ç»ç´ æèµ„产(Assets)API 接å£çš„傿•°ã€‚您å¯ä»¥ä½¿ç”¨ä»¥ä¸‹ Assets API 接å£åˆ›å»ºã€ç®¡ç†ä¸ªäººäººåƒç´ æèµ„产。 + +> 本文档仅é™é¢„览åŠé‚€æµ‹ç”¨æˆ·ä½¿ç”¨ï¼š +> +> * 䏿‰¿è¯ºæ­£å¼ API 上线100%一致。 +> +> * ä»…é™é‚€æµ‹ç”¨æˆ·é˜…读,请勿截图/分享给其他人员。 +> +> * 您需确ä¿ä¸Šä¼ çš„虚拟人åƒç¬¦åˆä»¥ä¸‹æ¡ä»¶ï¼š +> +> * æ‚¨åˆæ³•拥有该素æï¼Œå¹¶äº«æœ‰å®Œæ•´çš„使用åŠå¤„分æƒé™ã€‚ç´ æä¸åŒ…嫿œªèŽ·æŽˆæƒçš„ç¬¬ä¸‰æ–¹å•†æ ‡ã€æ ‡è¯†ç±»å†…容。 +> +> * ç´ æä¸å¾—ä¸Žä»»ä½•è‡ªç„¶äººè‚–åƒæˆ–形象雷åŒï¼Œç´ æä¸å­˜åœ¨æŠ„袭ã€ç›—用情形,ä¸ä¼šä¾µå®³ä»»ä½•第三方的人格æƒã€çŸ¥è¯†äº§æƒç­‰åˆæ³•æƒç›Šã€‚ +> +> * ç´ æä¸åŒ…å«è¿å法规ã€è¿èƒŒå…¬åºè‰¯ä¿—ã€å±å®³å›½å®¶å®‰å…¨çš„内容。 + + + +# ç´ æèµ„产(Assets)API 接å£åŠŸèƒ½ + +> **ç´ æèµ„产的概念说明:** +> +> * **Asset(素æèµ„产)**ï¼šä¸€ä¸ªç´ ææ–‡ä»¶ï¼ˆå›¾ç‰‡ï¼‰ï¼Œæ˜¯æ–¹èˆŸ Seedance 2.0 系列模型å¯ç›´æŽ¥ç”¨äºŽæŽ¨ç†çš„å¯ä¿¡èµ„产。 +> +> * 仅需入库推ç†éœ€ä½¿ç”¨çš„ç´ æèµ„产,ä¸éœ€ä½¿ç”¨çš„ç´ æèµ„产请勿入库。 +> +> * ä»…å¯ä½¿ç”¨å·²å…¥åº“ç´ æèµ„产的 Id (Asset ID) 进行视频生æˆï¼ŒåŒä¸€å½¢è±¡æœªå…¥åº“ç´ ææ— æ³•使用。 +> +> * **Asset Group(素æèµ„产组åˆï¼‰**:å•ä¸ªç´ ææ–‡ä»¶ä¸ºä¸€ä¸ª Asset,æ¯ä¸ª Asset 属于一个 Asset Group。 +> +> * å¯ä»¥ä½¿ç”¨ç´ æç»„自由管ç†ç´ æï¼Œä¾‹å¦‚å¯å°†åŒä¸€äººç‰©ã€åŒä¸€å·¥ä½œå®¤æˆ–é¡¹ç›®ç»„çš„ç´ ææ”¾å…¥åŒä¸€ç´ æç»„åˆè¿›è¡Œç®¡ç†ã€‚ + +**Asset (Group) 创建接å£ï¼š** + +1. CreateAssetGroup:创建素æèµ„产组åˆã€‚**首次创建素æèµ„äº§ç»„åˆæ—¶éœ€åœ¨æŽ§åˆ¶å°ç­¾ç½²æŽˆæƒå‡½ï¼Œè¯¦æƒ…å‚考 [ ç§åŸŸè™šæ‹Ÿäººåƒç´ æåº“ (WIP)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe)** + +2. CreatAsset:创建素æèµ„产。该接å£å¯ç”¨äºŽä¸Šä¼ ä¸ªäººç´ æèµ„产,创建素æèµ„产åŽå¯åˆ©ç”¨è¿”回字段中的素æ **Id (需处于 `active` 状æ€ï¼‰**用于 Seedance 2.0 系列模型生æˆè§†é¢‘。 + + + +**Asset (Group) ç®¡ç†æŽ¥å£ï¼š** + +* ListAssetGroups:查询素æèµ„产组åˆåˆ—表。 + +* ListAssets:查询素æèµ„产列表。 + +* GetAsset:查询素æèµ„产信æ¯ã€‚ + +* GetAssetGroup:查询素æèµ„产组åˆä¿¡æ¯ã€‚ + +* UpdateAssetGroup:更新素æèµ„产组åˆä¿¡æ¯ã€‚ + +* UpdateAsset:更新素æèµ„产信æ¯ã€‚ + + + +# é‰´æƒæ–¹å¼ + +调用素æèµ„产(Assets)API 接å£éœ€ä½¿ç”¨ Access Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [èŽ·å– API 访问密钥(AK/SK)](https://www.volcengine.com/docs/6257/64983?lang=zh)。 + + + +# 陿µè¦æ±‚ + +* 并呿•°é™åˆ¶ï¼šè´¦å·ä¸‹åŒä¸€æ—¶åˆ»åœ¨å¤„ç†ä¸­çš„任务数é‡ä¸Šé™ï¼Œè¶…过此é™åˆ¶çš„任务将进入队列等待处ç†ã€‚**åŒæ—¶è¿›è¡Œå¤„ç†çš„asset创建任务ä¸è¶…过30。** + +* QPS 陿µï¼š APIæŽ¥å£æ¯ç§’查询请求的总数上é™ã€‚超过此é™åˆ¶çš„æŸ¥è¯¢è¯·æ±‚会报错。 + +| 接å£å | è´¦å·ç»´åº¦çš„ QPS 陿µ | +| ---------------- | ------------ | +| CreateAssetGroup | 30 | +| CreateAsset | 30 | +| ListAssetGroups | 30 | +| ListAssets | 30 | +| GetAsset | 100 | +| GetAssetGroup | 100 | +| UpdateAsset | 30 | +| UpdateAssetGroup | 30 | + +# CreateAssetGroup + +> **POST **/open/CreateAssetGroup + +创建 Asset Group(素æèµ„产组åˆï¼‰ç»„åˆï¼Œç”¨ä½œç´ æèµ„产管ç†ã€‚ + +> **首次创建 Asset Group(素æèµ„产组åˆï¼‰éœ€åœ¨æŽ§åˆ¶å°ç­¾ç½²æŽˆæƒå‡½ï¼Œè¯¦æƒ…å‚考 [ ç§åŸŸè™šæ‹Ÿäººåƒç´ æåº“ (WIP)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe)** + +### **Name** `string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º 64 字符。 + +*** + +### **Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **GroupType **`string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +*** + +### **ProjectName **`string`** ** + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +返回示例: + +```bash +{ + "Id": "group-2026**********-*****" +} +``` + + + +# CreateAsset + +> **POST **/open/CreateAsset + +呿Œ‡å®šçš„Asset Group(素æèµ„产组åˆï¼‰å†…创建Asset(素æèµ„产)。 + + + +## è¯·æ±‚å‚æ•° + +### **GroupId** `string` `å¿…å¡«` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **URL** `string` `å¿…å¡«` + +传入的Asset(素æèµ„产)的公共å¯è®¿é—®åœ°å€ã€‚ + +*** + +### **Name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +### **AssetType `string` `å¿…å¡«`** + +Asset(素æèµ„产)的类型,当å‰ä»…支æŒä¼ å…¥å›¾åƒã€‚å¯é€‰å€¼ï¼š + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +> **传入图åƒçš„è¦æ±‚说明** +> +> * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gifã€heic/heif +> +> * 宽高比(宽/高): (0.4, 2.5) +> +> * 宽高长度(px):(300, 6000) +> +> * 大å°ï¼šå•张图片å°äºŽ 30 MB。 + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +> 需è¦å’Œå¾…传入的 Asset Group(素æèµ„产组åˆï¼‰çš„ **ProjectName **保æŒä¸€è‡´ã€‚ + +*** + + + +## è¿”å›žå‚æ•° + +### **Id **`string` + +Asset(素æèµ„产)的 Id。 + +*** + +返回示例: + +```bash +{ + "Id": "Asset-2026**********-*****" +} +``` + + + +# ListAssets + +> **POST **/open/ListAssets + +查询符åˆç­›é€‰æ¡ä»¶çš„Assets(素æèµ„产)列表。 + +## è¯·æ±‚å‚æ•° + +### **Filter** `object` `å¿…å¡«` + +æœç´¢çš„过滤æ¡ä»¶ã€‚ + +*** + +Filter.**GroupIds** `array` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Filter.**GroupType** `string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +*** + +Filter.**Statuses** `array`** ** + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +Filter.**Name** `string`** ** + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +### **PageNumber** `int (i64)` `å¿…å¡«` + +æœç´¢é¡µç ï¼Œå¯ç”¨äºŽåˆ—表分页功能,从 1 开始。例如:"page\_number": 1,å³è¿”回第一页的æœç´¢ç»“果。 + +*** + +### **PageSize** `int (i64)` `å¿…å¡«` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + +### **SortBy** `string` + +用于排åºçš„字段å称,默认值 `createTime`。支æŒä»¥ä¸‹ç±»åž‹ï¼š + +* CreateTime:根æ®åˆ›å»ºæ—¶é—´æŽ’åºã€‚ + +* UpdateTimeï¼šæ ¹æ®æ›´æ–°æ—¶é—´æŽ’åºã€‚ + +* GroupId:根æ®èµ„产素æç»„çš„ Id 排åºã€‚ + +*** + +### **SortOrder** `string` + +排åºé¡ºåºï¼Œé»˜è®¤å€¼ `Desc`。å¯é€‰å€¼ï¼š + +* Desc:é™åº + +* Asc:å‡åº + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Items** `array[]` + +符åˆç­›é€‰æ¡ä»¶çš„Asset(素æèµ„产)数组。 + +*** + +Items.**Id** `string` + +Asset(素æèµ„产)的 Id。 + +*** + +Items.**name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +Items.**URL** `string` + +Asset(素æèµ„产)的公共å¯è®¿é—®åœ°å€ã€‚ + +*** + +Items.**GroupId** `string` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Items.**AssetType** `string` + +Asset(素æèµ„产)的类型。 + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +*** + +Items.**Status** `string` + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +Items.**Error** `object` + +错误信æ¯ã€‚ + +*** + +Items.Error.**Code** `string` + +错误ç ã€‚ + +*** + +Items.Error.**Message** `string` + +错误信æ¯ã€‚ + +*** + +Items.**ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +Items.**CreateTime **`string` + +创建时间。 + +*** + +Items.**UpdateTime **`string` + +更新时间。 + +*** + +### **TotalCount **`int (i64)` + +返回总数。 + +*** + +### **PageNumber **`int (i64)` + +返回的页数。 + +*** + +### **PageSize **`int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + + + +# ListAssetGroups + +> **POST **/open/ListAssetGroups + +查询符åˆç­›é€‰æ¡ä»¶çš„Asset Groups(素æèµ„产组åˆï¼‰åˆ—表。 + +## è¯·æ±‚å‚æ•° + +### **Filter** `object` `å¿…å¡«` + +æœç´¢çš„过滤æ¡ä»¶ã€‚ + +*** + +Filter.**name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +Filter.**GroupIds** `array` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Filter.**GroupType** `string`** **`å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。å¯é€‰å€¼ï¼š + +* AIGC:虚拟人åƒã€‚ + +*** + +### **PageNumber** `int (i64)` + +æœç´¢é¡µç ï¼Œå¯ç”¨äºŽåˆ—表分页功能,从 1 开始。例如:"page\_number": 1,å³è¿”回第一页的æœç´¢ç»“果。 + +*** + +### **PageSize** `int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + +### **SortBy** `string` + +用于排åºçš„字段å称,默认值 `createTime`。支æŒä»¥ä¸‹ç±»åž‹ï¼š + +* CreateTime:根æ®åˆ›å»ºæ—¶é—´æŽ’åºã€‚ + +* UpdateTimeï¼šæ ¹æ®æ›´æ–°æ—¶é—´æŽ’åºã€‚ + +*** + +### **SortOrder** `string` + +排åºé¡ºåºï¼Œé»˜è®¤å€¼ `Desc`。å¯é€‰å€¼ï¼š + +* Desc:é™åº + +* Asc:å‡åº + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **TotalCount **`int (i64)` + +返回的 Asset Group(素æèµ„产组åˆï¼‰çš„æ€»æ•°ã€‚ + +*** + +### **Items** `array[]` + +符åˆç­›é€‰æ¡ä»¶çš„ Asset Group(素æèµ„产组åˆï¼‰æ•°ç»„。 + +*** + +Items.**Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +Items.**Name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +Items.**Title** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æ ‡é¢˜ã€‚ + +> å³å°†ä¸‹çº¿ï¼Œè¯·ç›´æŽ¥ä½¿ç”¨å‚æ•° Name + +*** + +Items.**Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +Items.**GroupType** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。 + +* AIGC:虚拟人åƒã€‚ + +*** + +Items.**ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +Items.**CreateTime** `string` + +创建时间。 + +*** + +Items.**UpdateTime** `string` + +更新时间。 + +*** + +### **PageNumber **`int (i64)` + +返回的页数。 + +*** + +### **PageSize **`int (i64)` + +æ¯é¡µæœç´¢ç»“果的数é‡ï¼Œä¸Šé™ä¸º100。 + +*** + + + +# GetAssetGroup + +> **POST **/open/GetAssetGroup + +获å–å•个Asset Group(素æèµ„产组åˆï¼‰ä¿¡æ¯ã€‚ + +## è¯·æ±‚å‚æ•° + + + +### **Id **`string` `å¿…å¡«` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id + +*** + +### **ProjectName **`string` + +éœ€è¦æŸ¥è¯¢çš„ Asset Group(素æèµ„产组åˆï¼‰æ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **Name** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„å称,上é™ä¸º64个字符。 + +*** + +### **Title** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æ ‡é¢˜ã€‚ + +> å³å°†ä¸‹çº¿ï¼Œè¯·ç›´æŽ¥ä½¿ç”¨å‚æ•° Name + +*** + +### **Description** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **GroupType **`string` + +Asset Group(素æèµ„产组åˆï¼‰çš„类型。 + +* AIGCï¼šè™šæ‹Ÿäººåƒ + +*** + +### **ProjectName **`string`** ** + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +### **CreateTime **`string` + +创建时间。 + +*** + +### **UpdateTime **`string` + +更新时间。 + +*** + +## + +# GetAsset + +> **POST **/open/GetAsset + +获å–å•个Asset(素æèµ„产)信æ¯ã€‚ + +## è¯·æ±‚å‚æ•° + + + +### **Id **`string` `å¿…å¡«` + +Asset(素æèµ„产)的 Id。 + +*** + +### **ProjectName **`string` + +éœ€è¦æŸ¥è¯¢çš„ Asset(素æèµ„产)所属的项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id **`string` + +Asset(素æèµ„产)的 Id。 + +*** + +### **Name** `string` + +Asset(素æèµ„产)的å称,上é™ä¸º64个字符。 + +*** + +### **URL **`string` + +Asset(素æèµ„产)的访问地å€ã€‚ + +*** + +### **AssetType **`string` + +Asset(素æèµ„产)的类型。 + +* Image:Asset(素æèµ„产)的类型为图åƒã€‚ + +*** + +### **GroupId** `string` + +Asset(素æèµ„产)所属的 Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + +### **Status** `string` + +任务状æ€ã€‚ + +* Active:素æèµ„产(Asset)已处ç†å®Œæ¯•,å¯ä»¥ä½¿ç”¨ã€‚ + +* Processing:素æèµ„产(Asset)正在预处ç†ï¼Œæ— æ³•使用。 + +* Failed:素æèµ„产(Asset)处ç†å¤±è´¥ã€‚ + +*** + +### **Error** `object` + +错误信æ¯ã€‚ + +*** + +Error.**Code** `string` + +错误ç ã€‚ + +*** + +Error.**Message** `string` + +错误信æ¯ã€‚ + +*** + +### **CreateTime **`string` + +创建时间。 + +*** + +### **UpdateTime ** `string` + +更新时间。 + +*** + +### **ProjectName** `string` + +èµ„æºæ‰€å±žçš„项目å称。 + +*** + +## + +# **UpdateAssetGroup** + +> **POST **/open/UpdateAssetGroup + +æ›´æ–°å•个 Asset Group(素æèµ„产组åˆï¼‰ä¿¡æ¯ã€‚当å‰ä»…æ”¯æŒæ›´æ–° Asset Group(素æèµ„产组åˆï¼‰çš„ Name å’Œ Description。 + +## è¯·æ±‚å‚æ•° + +### **Id **`string` `å¿…å¡«` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„ Id + +*** + +### **Name **`string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„æ–°å称,上é™ä¸º64个字符。 + +*** + +### **Description** `string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰çš„æ–°æè¿°ï¼Œä¸Šé™ä¸º 300 字符。 + +*** + +### **ProjectName** `string` + +éœ€è¦æ›´æ–°çš„ Asset Group(素æèµ„产组åˆï¼‰æ‰€å±žçš„项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset Group(素æèµ„产组åˆï¼‰çš„ Id。 + +*** + + + + + +# **UpdateAsset** + +> **POST **/open/UpdateAsset + +æ›´æ–°å•个Asset(素æèµ„产)信æ¯ã€‚当å‰ä»…æ”¯æŒæ›´æ–°Asset(素æèµ„产)的 Name。 + +## è¯·æ±‚å‚æ•° + +### **Id **`string` `å¿…å¡«` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)的 Id + +*** + +### **Name **`string` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)的新å称,上é™ä¸º64个字符。 + +*** + +### **ProjectName** `string` + +éœ€è¦æ›´æ–°çš„ Asset(素æèµ„产)所属的项目å称,默认值为`default`。 + +若资æºä¸åœ¨é»˜è®¤é¡¹ç›®ä¸­ï¼Œéœ€å¡«å†™æ­£ç¡®çš„项目å称,获å–项目å称,请查看 [文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +*** + + + +## è¿”å›žå‚æ•° + +### **Id** `string` + +Asset(素æèµ„产)的 Id。 + +*** + + + +# 代ç ç¤ºä¾‹ï¼š + +> **以下示例为使用 Asset API 创建素æèµ„产并用于视频生æˆçš„使用链路:** +> +> 1. **创建素æèµ„产组åˆï¼š**调用 **CreateAssetGroup** 接å£åˆ›å»ºä¸€ä¸ªç´ æèµ„产组åˆï¼ˆAsset Group),用于对åŒä¸€é¡¹ç›®æˆ–人物的素æè¿›è¡Œç»Ÿä¸€ç®¡ç†ã€‚首次创建时需在控制å°ç­¾ç½²æŽˆæƒå‡½ã€‚ +> +> 2. **上传素æèµ„产并等待预处ç†å®Œæˆï¼š**调用 **CreateAsset** 接å£ä¸Šä¼ å›¾ç‰‡ç´ æï¼Œä¼ å…¥å›¾ç‰‡çš„公共访问URLåŠæ‰€å±žçš„Group ID,获得素æèµ„产ID(Asset ID)。 +> 由于上传的素æèµ„产需ç»è¿‡é¢„处ç†åŽæ‰èƒ½ä½¿ç”¨ï¼Œå¯è½®è¯¢è°ƒç”¨ **GetAsset** æŽ¥å£æŸ¥è¯¢ç´ æçжæ€ï¼Œç›´è‡³çжæ€å˜ä¸º `Active`。若状æ€ä¸º `Failed` 则表示处ç†å¤±è´¥ã€‚ +> +> 3. **åœ¨è§†é¢‘ç”Ÿæˆ API 中使用素æï¼š**当ç´ æèµ„产状æ€ä¸º `Active` åŽï¼Œå°†ç´ æID按 `Asset://` çš„æ ¼å¼æ‹¼æŽ¥æˆURL,在视频生æˆAPI(如Seedance 2.0系列模型)的请求中,将该URL作为å‚考图åƒçš„ `image_url` 传入,å³å¯ä½¿ç”¨è¯¥ç´ æèµ„产生æˆè§†é¢‘。 +> +> **API é‰´æƒæ–¹å¼åŒºåˆ«è¯´æ˜Ž** +> +> * **Asset API:**Access Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [èŽ·å– API 访问密钥(AK/SK)](https://www.volcengine.com/docs/6257/64983?lang=zh)。 +> +> * **è§†é¢‘ç”Ÿæˆ API:**API Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [ç®¡ç† API Key](https://www.volcengine.com/docs/82379/1361424?lang=zh)。 +> +> **ç´ æåº“[项目](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)(Project)隔离说明** +> +> * 呿Œ‡å®šçš„ Asset Group(素æèµ„产组åˆï¼‰å†…创建或查询 Asset(素æèµ„产)时,需ä¿è¯ä¸¤è€…çš„ **ProjectName **一致 +> +> * Asset(素æèµ„产)所属的 **ProjectName** éœ€ä¸Žè°ƒç”¨è§†é¢‘ç”Ÿæˆ API æŽ¥å£æ—¶ä½¿ç”¨çš„ API key 所属的 **ProjectName** 一致 + +## 1. 创建素æèµ„äº§ç»„åˆ + +```go +package main + +import ( + "fmt" + + "github.com/bytedance/sonic" + "github.com/volcengine/volcengine-go-sdk/volcengine" + "github.com/volcengine/volcengine-go-sdk/volcengine/credentials" + "github.com/volcengine/volcengine-go-sdk/volcengine/session" + "github.com/volcengine/volcengine-go-sdk/volcengine/universal" +) + +func main() { + config := volcengine.NewConfig().WithCredentials(credentials.NewStaticCredentials("", "", "")).WithRegion("cn-beijing") + sess, _ := session.NewSession(config) + resp, err := universal.New(sess).DoCall( + universal.RequestUniversal{ + ServiceName: "ark", + Action: "CreateAssetGroup", + Version: "2024-01-01", + HttpMethod: universal.POST, + ContentType: universal.ApplicationJSON, + }, + //æ ¹æ®å®žé™…情况填写 + &map[string]any{ + "Name": "test", + "Description": "test", + "GroupType": "AIGC", + }, + ) + if err != nil { + return + } + if resp == nil { + return + } + respData, err := sonic.Marshal(resp) + fmt.Println(string(respData)) +} +``` + +返回示例 + +```json +{"ResponseMetadata":{"RequestId":"20260318155041036F7CB6362358FB40FC","Action":"CreateAssetGroup","Version":"2024-01-01","Service":"ark","Region":"cn-beijing"},"Result":{"Id":"group-2026**********-*****"}} +``` + + + +## 2. 上传素æèµ„产并获å–ç´ æèµ„äº§ä¿¡æ¯ + +```go +package main + +import ( + "errors" + "fmt" + "time" + + "github.com/bytedance/sonic" + "github.com/volcengine/volcengine-go-sdk/volcengine" + "github.com/volcengine/volcengine-go-sdk/volcengine/credentials" + "github.com/volcengine/volcengine-go-sdk/volcengine/session" + "github.com/volcengine/volcengine-go-sdk/volcengine/universal" +) + +const ( + region = "cn-beijing" + serviceName = "ark" + version = "2024-01-01" + + // 轮询é…ç½® + pollInterval = 3 * time.Second + pollTimeout = 2 * time.Minute +) + +func main() { + // TODO: 替æ¢ä¸ºä½ çš„ AK / SK + ak := "" + sk := "" + + // TODO: 替æ¢ä¸ºä½ çš„å®žé™…å‚æ•° + groupID := "" + assetURL := "" + assetType := "Image" + projectName := "Default" + + config := volcengine.NewConfig(). + WithCredentials(credentials.NewStaticCredentials(ak, sk, "")). + WithRegion(region) + + sess, err := session.NewSession(config) + if err != nil { + fmt.Printf("create session failed: %v\n", err) + return + } + + client := universal.New(sess) + + // 1. 创建素æèµ„产 + assetID, err := createAsset(client, groupID, assetURL, assetType, projectName) + if err != nil { + fmt.Printf("create asset failed: %v\n", err) + return + } + + fmt.Printf("asset created, AssetId = %s\n", assetID) + + // 2. 查询素æèµ„äº§çŠ¶æ€ + finalURL, err := waitForAssetActive(client, assetID, pollInterval, pollTimeout) + if err != nil { + fmt.Printf("poll asset failed: %v\n", err) + return + } + + fmt.Printf("asset is active, URL = %s\n", finalURL) +} + +// createAsset 调用 CreateAsset 并返回 AssetId +func createAsset(client *universal.Universal, groupID, url, assetType, projectName string) (string, error) { + resp, err := client.DoCall( + universal.RequestUniversal{ + ServiceName: serviceName, + Action: "CreateAsset", + Version: version, + HttpMethod: universal.POST, + ContentType: universal.ApplicationJSON, + }, + &map[string]any{ + "GroupId": groupID, + "URL": url, + "AssetType": assetType, + "ProjectName": projectName, + }, + ) + if err != nil { + return "", err + } + if resp == nil { + return "", errors.New("create asset response is nil") + } + + // 打å°åŽŸå§‹è¿”å›žï¼Œä¾¿äºŽæŽ’æŸ¥ + respData, _ := sonic.Marshal(resp) + fmt.Printf("CreateAsset response: %s\n", string(respData)) + + assetID := extractString(resp, "Result", "Id") + if assetID == "" { + assetID = extractString(resp, "Result", "AssetId") + } + if assetID == "" { + assetID = extractString(resp, "Id") + } + if assetID == "" { + assetID = extractString(resp, "AssetId") + } + + if assetID == "" { + return "", fmt.Errorf("cannot find AssetId in response: %s", string(respData)) + } + + return assetID, nil +} + +// waitForAssetActive 查询 GetAsset,直到 Active / Failed / è¶…æ—¶ +func waitForAssetActive(client *universal.Universal, assetID string, interval, timeout time.Duration) (string, error) { + deadline := time.Now().Add(timeout) + + for { + if time.Now().After(deadline) { + return "", fmt.Errorf("polling timeout after %v, assetID=%s", timeout, assetID) + } + + status, url, errMsg, err := getAssetStatus(client, assetID) + if err != nil { + return "", err + } + + fmt.Printf("asset status: %s\n", status) + + switch status { + case "Processing": + time.Sleep(interval) + continue + case "Active": + if url == "" { + return "", fmt.Errorf("asset is Active but URL is empty, assetID=%s", assetID) + } + return url, nil + case "Failed": + if errMsg == "" { + errMsg = "unknown asset processing error" + } + return "", fmt.Errorf("asset processing failed: %s", errMsg) + default: + // 若返回其他状æ€ï¼Œä¿å®ˆå¤„ç†ä¸ºç»§ç»­æŸ¥è¯¢ + fmt.Printf("unexpected status %q, continue polling...\n", status) + time.Sleep(interval) + } + } +} + +// getAssetStatus 调用 GetAsset,返回 Status / URL / Error +func getAssetStatus(client *universal.Universal, assetID string) (status, url, errMsg string, err error) { + resp, err := client.DoCall( + universal.RequestUniversal{ + ServiceName: serviceName, + Action: "GetAsset", + Version: version, + HttpMethod: universal.POST, + ContentType: universal.ApplicationJSON, + }, + &map[string]any{ + "Id": assetID, + }, + ) + if err != nil { + return "", "", "", err + } + if resp == nil { + return "", "", "", errors.New("get asset response is nil") + } + + // 打å°åŽŸå§‹è¿”å›žï¼Œä¾¿äºŽæŽ’æŸ¥ + respData, _ := sonic.Marshal(resp) + fmt.Printf("GetAsset response: %s\n", string(respData)) + + // 兼容ä¸åŒå±‚级的字段ä½ç½® + status = extractString(resp, "Result", "Status") + if status == "" { + status = extractString(resp, "Status") + } + + url = extractString(resp, "Result", "URL") + if url == "" { + url = extractString(resp, "URL") + } + + errMsg = extractString(resp, "Result", "Error") + if errMsg == "" { + errMsg = extractString(resp, "Error") + } + + return status, url, errMsg, nil +} + +// extractString 从å“应中按层级安全æå–字符串 +func extractString(data any, keys ...string) string { + current := data + + for _, key := range keys { + switch v := current.(type) { + case map[string]any: + next, ok := v[key] + if !ok { + return "" + } + current = next + + case *map[string]any: + if v == nil { + return "" + } + next, ok := (*v)[key] + if !ok { + return "" + } + current = next + + default: + return "" + } + } + + switch v := current.(type) { + case string: + return v + case fmt.Stringer: + return v.String() + case nil: + return "" + default: + return fmt.Sprintf("%v", v) + } +} +``` + +返回示例 + +```json +CreateAsset response: {"ResponseMetadata":{"RequestId":"202603181520431F067112A17FC078A6DF","Action":"CreateAsset","Version":"2024-01-01","Service":"ark","Region":"cn-beijing"},"Result":{"Id":"Asset-2026**********-*****"}} +asset created, AssetId = asset-20260318072044-n8bcl +GetAsset response: {"ResponseMetadata":{"Service":"ark","Region":"cn-beijing","RequestId":"202603181520448A995106924553F77D0E","Action":"GetAsset","Version":"2024-01-01"},"Result":{"Name":"","GroupId":"group-2026**********-*****","CreateTime":"2026-03-18T07:20:44Z","ProjectName":"default","Id":"Asset-2026**********-*****","URL":"","AssetType":"Image","Status":"Processing","UpdateTime":"2026-03-18T07:20:44Z"}} +asset status: Processing +GetAsset response: {"Result":{"UpdateTime":"2026-03-18T07:20:47Z","ProjectName":"default","Id":"Asset-2026**********-*****","CreateTime":"2026-03-18T07:20:44Z","Name":"","URL":"","AssetType":"Image","GroupId":"group-2026**********-*****","Status":"Processing"},"ResponseMetadata":{"Version":"2024-01-01","Service":"ark","Region":"cn-beijing","RequestId":"2026031815204766FE2BA543E6FF666F66","Action":"GetAsset"}} +asset status: Processing +GetAsset response: {"ResponseMetadata":{"Version":"2024-01-01","Service":"ark","Region":"cn-beijing","RequestId":"202603181520511F067112A17FC078A75A","Action":"GetAsset"},"Result":{"Name":"","URL":"https://ark-media-asset-stg.tos-cn-beijing.volces.com/xxxx","AssetType":"Image","Status":"Active","Id":"Asset-2026**********-*****","GroupId":"group-2026**********-*****","CreateTime":"2026-03-18T07:20:44Z","UpdateTime":"2026-03-18T07:20:47Z","ProjectName":"default"}} +asset status: Active +asset is active, URL = https://ark-media-asset-stg.tos-cn-beijing.volces.com/xxxx +``` + + + +更多语言的示例代ç è¯¦è§ï¼š + +> æ³¨æ„æ›¿æ¢ Demo 中的 AK与SK,若需调用其他接å£å¦‚ ListAssetsï¼Œéœ€æ›¿æ¢ ACTION ä¸Žå¯¹åº”è¯·æ±‚å‚æ•°ã€‚ + +| **Python** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产并获å–ç´ æèµ„产信æ¯ï¼š | +| ---------- | --------------------------- | +| **Java** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产并获å–ç´ æèµ„产信æ¯ï¼š | +| **PHP** | 创建素æèµ„产组åˆï¼š 上传素æèµ„产: | + + + +## 3. ç´ æèµ„äº§ç”¨äºŽè§†é¢‘ç”Ÿæˆ + +当上传的素æèµ„产状æ€ä¸º `Active` 时,å¯å°†ç´ æ Id 按 `Asset: //` 的规则拼接 URL,以在 **è§†é¢‘ç”Ÿæˆ API **中使用对应的素æèµ„产生æˆè§†é¢‘: + +```json + { + "type": "image_url", + "image_url": { + "url": "Asset://Asset-2026**********-*****" + }, + "role": "reference_image" + }, +``` + +使用素æèµ„产生æˆè§†é¢‘的具体调用方å¼è¯·å‚考[ ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版)](https://bytedance.larkoffice.com/wiki/SANpwJ9bgiKgrykLaMTcAB0InWc#share-ONSwd51ezoXCJqxkAm2cIC61nMX)。 + diff --git a/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版).md b/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版).md new file mode 100644 index 0000000..acb3826 --- /dev/null +++ b/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版).md @@ -0,0 +1,128 @@ +# 「⚠ï¸ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】控制å°ä¸Šä¼ è‡ªæœ‰è™šæ‹Ÿäººåƒè‡³ç´ æèµ„产库(邀测用户版) + +> 请注æ„,仅开白用户在控制å°å¯见**《上传虚拟人åƒç´ æåˆè§„承诺函》**的签署入å£ï¼Œè‹¥ä»…å¯见**《素æèµ„产功能使用规则》**,则需申请开白 + +# 1. ä»‹ç» + +3月19日起功能上线åŽï¼Œç«å±±æ–¹èˆŸä¼šåœ¨æŽ§åˆ¶å°æ”¯æŒå®Œæˆå¼€ç™½çš„B端客户批é‡ä¸Šä¼ å’Œç®¡ç†è™šæ‹Ÿäººèµ„äº§ï¼ŒåŒæ—¶æ”¯æŒä½¿ç”¨API创建ã€ç®¡ç†ï¼Œå…许ä¼ä¸šä¸Šä¼ **自有AIGC虚拟人**(å«å“牌定制 IPã€è‡ªåˆ¶æ•°å­—人ã€é‡‡è´­çš„åˆè§„虚拟人等),在线勾选确认**《上传虚拟人åƒç´ æåˆè§„承诺函》**,承诺上传的虚拟人åƒä¸ºä¼ä¸šåˆæ³•æ‰€æœ‰ã€æœªä¾µçŠ¯ä»»ä½•ç¬¬ä¸‰æ–¹æƒç›Šã€ä¸ä¸Žä»»ä½•自然人的肖åƒå½¢è±¡ç›¸åŒæˆ–相似ã€ä»…用于åˆè§„用途,å³å¯å®Œæˆç¡®æƒï¼Œå°†è™šæ‹Ÿäººåƒä¸Šä¼ å…¥åº“,在推ç†ä¸­ä½¿ç”¨ï¼Œä»…å¯ä½¿ç”¨å·²å…¥åº“的素æèµ„产进行视频生æˆï¼Œæœªå…¥åº“ç´ æï¼Œå³ä½¿ä¸ºå·²å…¥åº“åŒä¸€è§’色的ä¸åŒå¦†é€ ï¼Œä¹Ÿæ— æ³•使用。 + + + +# 2. 使用æµç¨‹ + +![ç”»æ¿ 1](images/whiteboard_1_1774075398978.png) + +| | 释义 | 举例 | +| --------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **ç´ æèµ„产(Asset)** | ä¸€ä¸ªç´ ææ–‡ä»¶ï¼ˆæœ¬æœŸ**仅支æŒå›¾ç‰‡**),是方舟Seedance系列模型å¯ç›´æŽ¥ç”¨äºŽæŽ¨ç†çš„å¯ä¿¡èµ„产 | ![Image Token: QwfCbg7HWodX84x6Jwdl8iWxg6d](images/QwfCbg7HWodX84x6Jwdl8iWxg6d.png) | +| **资产组åˆï¼ˆGroup)** | 将原å­åŒ–的资产(Asset)组åˆèµ·æ¥ï¼Œå¯ä»¥äººç‰©ã€å·¥ä½œå®¤ã€é¡¹ç›®ç»„等维度将素æè¿›è¡Œåˆ†ç»„ç®¡ç† | ![Image Token: KXmAbBvXTophYGxhUzulqOfWgab](images/KXmAbBvXTophYGxhUzulqOfWgab.png)![Image Token: S1KRbfaOzoyqNux7uh4laVqVgZc](images/S1KRbfaOzoyqNux7uh4laVqVgZc.png)![Image Token: YMKAbeeLpowghBxfQxmlzfPngAf](images/YMKAbeeLpowghBxfQxmlzfPngAf.png) | + +## 2.1 æ–¹èˆŸæŽ§åˆ¶å° + +1. **首次使用签署使用承诺函**:开白用户å¯è§**ç«å±±æ–¹èˆŸä½“验中心-视觉模型-视频生æˆé¡µé¢é¡¶éƒ¨ã€æˆ‘的素æèµ„产】**,点击进入素æèµ„产管ç†ç•Œé¢ï¼Œé¦–次使用å‰éœ€ç­¾ç½²ã€Šä¸Šä¼ è™šæ‹Ÿäººåƒç´ æåˆè§„承诺函》《素æèµ„产功能使用规则》(仅需授æƒä¸€æ¬¡ï¼‰ + +![Image Token: ZD36bcZEgo9FXnxm6lvlEX00gqY](images/ZD36bcZEgo9FXnxm6lvlEX00gqY.png) + +![ä½“éªŒä¸­å¿ƒã€æˆ‘的资产】首次进入时,调起å议弹窗 (Token: EHCSbgUCyocNvdxn4Qql6nHfgab)](images/EHCSbgUCyocNvdxn4Qql6nHfgab.png) + +* **创建素æèµ„产组åˆï¼ˆGroup)**:å¯é€šè¿‡æŽ§åˆ¶å°ä¸Šä¼ å•个或多个资产文件批é‡åˆ›å»ºç´ æèµ„产组åˆï¼ˆGroup),**当å‰ä»…支æŒä¸Šä¼ çš„æ¯ä¸ªæ–‡ä»¶åˆ†åˆ«åˆ›å»ºèµ„äº§ç»„ï¼Œæš‚ä¸æ”¯æŒåˆ›å»ºä¸€ä¸ªèµ„äº§ç»„ï¼ŒåŒæ—¶æ³¨å…¥å¤šä¸ªèµ„产** + +![ã€æˆ‘的素æèµ„äº§ã€‘é¢æ¿ï¼Œå³ä¸Šè§’ç‚¹å‡»ã€æ·»åŠ ç´ æèµ„产组】 (Token: HfQvbsOknoJ2MfxVTuVlpKqjg0c)](images/HfQvbsOknoJ2MfxVTuVlpKqjg0c.png) + +![Image Token: H7fabAsJSon7mqx0yzklmB20gXb](images/H7fabAsJSon7mqx0yzklmB20gXb.png) + +![点击上传/拖拽上传文件 (Token: XNrTbx6f9onxK6xzEHmlpPApgNb)](images/XNrTbx6f9onxK6xzEHmlpPApgNb.png) + +* 啿¬¡åˆ›å»ºä¸Šé™ä¸º**100个资产组åˆï¼ˆGroup)**,å•è´¦å·å…许的资产组åˆï¼ˆGroupï¼‰æ•°é‡æœ¬æœŸä¸è®¾é™ + +* å•个素æä¸Šä¼ è¦æ±‚: + +> - **图片格å¼**ï¼šæŽ§åˆ¶å°æœ¬æœŸä»…æ”¯æŒæ–‡ä»¶åŽç¼€ä¸º`.jpg`ã€`.jpeg`ã€`.png`(与API有差异) +> +> - **文件大å°**:å•张图片å°äºŽ30M +> +> - **宽高比(宽/高)**:(0.4, 2.5) +> +> - **宽高长度(px)**:(300, 6000) + +* èµ„äº§ç»„åˆæ ‡é¢˜/æè¿°/资产å称字段: + + | **资产组åˆå称(Group Name)** | 必填,最大字符12(与API有差异) | + | ----------------------------- | ------------------- | + | **èµ„äº§ç»„åˆæè¿°ï¼ˆGroup Description)** | 选填,最大字符100(与API有差异) | + | **资产å称(Asset Name)** | 必填,最大字符12(与API有差异) | + + ![Image Token: OLX5bqDmuoFvScxMSjoldvMngcg](images/OLX5bqDmuoFvScxMSjoldvMngcg.png) + + * 控制å°ä¸Šä¼ æ—¶æš‚䏿”¯æŒç›´æŽ¥ç¼–辑上述字段, 支æŒé€šè¿‡æ–‡ä»¶å‘½åè‡ªåŠ¨è§£æž + + > 命å规范:`{AssetName1}&&{GroupName1}&&{GroupDescription1(选填)}.jpg` + > + > 若无`&&`连接符,则文件å=`GroupName`=`AssetName` + + * `GroupName`**或**`GroupDescription`**被审核拦截时,Group会创建失败** + + * 创建完æˆåŽæ”¯æŒä¿®æ”¹ä¸Šè¿°å­—段 + +![èµ„äº§ç»„åˆæ ‡é¢˜ã€æè¿°ä¿®æ”¹ (Token: CpDGb1DkHoT0H7xymYXl0fl5gci)](images/CpDGb1DkHoT0H7xymYXl0fl5gci.png) + +![资产å称修改 (Token: FGx3bIe8toKJVixJekllAYmXgsc)](images/FGx3bIe8toKJVixJekllAYmXgsc.png) + + + +* **æ‰¹é‡æ–°å¢žç´ æ**:å¯ç‚¹å‡»è¿›å…¥æŸä¸ªèµ„产组åˆï¼ˆGroup),在当å‰èµ„产组åˆï¼ˆGroup)下新增资产(Asset) + +![点击æŸä¸€Group进入详情 (Token: J2bibWD6SoH170xehXWler3ugrg)](images/J2bibWD6SoH170xehXWler3ugrg.png) + +![Image Token: NfxBbdQa9oXQpWxT1GoljirmgXe](images/NfxBbdQa9oXQpWxT1GoljirmgXe.png) + +![点击å³ä¸Šè§’ã€æ·»åŠ ç´ æèµ„产】上传Asset (Token: CsgQbFnXOoTJACx2TeZlrQlHgrd)](images/CsgQbFnXOoTJACx2TeZlrQlHgrd.png) + +* 啿¬¡æ–°å¢žç´ æä¸Šé™ä¸º**500个资产**,å•è´¦å·å…许的资产(Assetï¼‰æ•°é‡æœ¬æœŸ**ä¸è®¾é™** + +* å•个素æä¸Šä¼ è¦æ±‚: + +> - **图片格å¼**ï¼šæŽ§åˆ¶å°æœ¬æœŸä»…æ”¯æŒæ–‡ä»¶åŽç¼€ä¸º`.jpg`ã€`.jpeg`ã€`.png`(与API有差异) +> +> - **文件大å°**:å•张图片å°äºŽ30M +> +> - **宽高比(宽/高)**:(0.4, 2.5) +> +> - **宽高长度(px)**:(300, 6000) + +* 文件å会自动解æžå¡«å…¥AssetName + +| **资产å称(Asset Name)** | 必填,最大字符12(与API有差异) | +| -------------------- | ------------------ | + +* **文件内容或**`AssetName`**被审核拦截时,Asset列表会展示失败状æ€ï¼Œæœ‰å¯¹åº”报错信æ¯ã€‚** + +![æŠ¥é”™ç¤ºæ„ (Token: Bt9Vbf3ajohV07xVrK1lYKe2gOc)](images/Bt9Vbf3ajohV07xVrK1lYKe2gOc.png) + + + +* **库内资产使用**:å¯åœ¨ä½“éªŒä¸­å¿ƒç•Œé¢æŸ¥çœ‹å·²ä¸Šä¼ çš„资产组åˆï¼ˆGroup)和对应组åˆä¸‹çš„资产(Asset),一键填入体验中心输入框,或一键å¤åˆ¶URI通过APIä¼ å…¥ + +![Image Token: Cv3AbbvFHoQuTcxacZclfNfggRc](images/Cv3AbbvFHoQuTcxacZclfNfggRc.png) + +![Image Token: DuDib9l3Ao8NsTx8E0Fl9eQEglb](images/DuDib9l3Ao8NsTx8E0Fl9eQEglb.png) + +![体验中心使用æµç¨‹ç¤ºæ„ (Token: YdKqbTI8fojMc5xAqAElrdOggff)](images/YdKqbTI8fojMc5xAqAElrdOggff.png) + + + +## 2.2 API入库 + +1. **首次使用签署使用承诺函**:通过ç«å±±æ–¹èˆŸæŽ§åˆ¶å°å¼€é€šç®¡ç†ï¼Œç‚¹å‡»å³ä¸Šè§’çš„ã€å¼€é€šç´ æèµ„产库æƒé™ã€‘ï¼Œå‹¾é€‰åŒæ„å议,进行功能开通使用 + +![Image Token: Vvu2bZwhGoTs8MxPc9jlB1rigjh](images/Vvu2bZwhGoTs8MxPc9jlB1rigjh.png) + + + +* **通过Asset API创建ã€ç®¡ç†ç´ æèµ„产:** + + > **ã€å¯¹å®¢ææ–™ã€‘** + > + > * **ç´ æèµ„产库实践手册:**[ ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库(邀测用户版)](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe) + > + > * **Asset API文档:**[ ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Asset API å‚考文档(邀测用户版)](https://bytedance.larkoffice.com/wiki/FtqVwjinYisraGkT5uncWyd0nEb) diff --git a/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版).md b/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版).md new file mode 100644 index 0000000..4ec7452 --- /dev/null +++ b/docs/API文档/「ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版).md @@ -0,0 +1,314 @@ +# 「⚠ï¸ä¿å¯†ä¿¡æ¯ã€ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】ç§åŸŸè™šæ‹Ÿäººåƒç´ æèµ„产库使用指å—(邀测用户版) + +> 本文档仅é™é¢„览åŠé‚€æµ‹ç”¨æˆ·ä½¿ç”¨ï¼š +> +> * 䏿‰¿è¯ºæ­£å¼ API 上线100%一致。 +> +> * ä»…é™é‚€æµ‹ç”¨æˆ·é˜…读,请勿截图/分享给其他人员。 +> +> * 您需确ä¿ä¸Šä¼ çš„虚拟人åƒç¬¦åˆä»¥ä¸‹æ¡ä»¶ï¼š +> +> * æ‚¨åˆæ³•拥有该素æï¼Œå¹¶äº«æœ‰å®Œæ•´çš„使用åŠå¤„分æƒé™ã€‚ç´ æä¸åŒ…嫿œªèŽ·æŽˆæƒçš„ç¬¬ä¸‰æ–¹å•†æ ‡ã€æ ‡è¯†ç±»å†…容。 +> +> * ç´ æä¸å¾—ä¸Žä»»ä½•è‡ªç„¶äººè‚–åƒæˆ–形象雷åŒï¼Œç´ æä¸å­˜åœ¨æŠ„袭ã€ç›—用情形,ä¸ä¼šä¾µå®³ä»»ä½•第三方的人格æƒã€çŸ¥è¯†äº§æƒç­‰åˆæ³•æƒç›Šã€‚ +> +> * ç´ æä¸åŒ…å«è¿å法规ã€è¿èƒŒå…¬åºè‰¯ä¿—ã€å±å®³å›½å®¶å®‰å…¨çš„内容。 + +Seedance 2.0 系列模型具有完备的防范 Deepfake 和侵犯版æƒé£Žé™©èƒ½åŠ›ã€‚åœ¨ç”Ÿæˆè§†é¢‘时,会对有风险的å‚考素æè¾“入进行拦截,最大é™åº¦ä¿è¯ç”Ÿæˆè§†é¢‘åˆè§„和安全性。 + +为确ä¿åˆ›ä½œè€…能充分利用 Seedance 2.0 强大的视频生æˆèƒ½åŠ›é«˜æ•ˆç”Ÿæˆè§†é¢‘å†…å®¹ï¼ŒåŒæ—¶è§„é¿ AI 生æˆå†…容的潜在风险,方舟推出了ç§åŸŸå¯ä¿¡ç´ æåº“。完æˆå…¥åº“çš„å¯ä¿¡ç´ æå°†è¿›å…¥æ‚¨çš„ç§åŸŸç´ æåº“,在视频生æˆä¸­ä½¿ç”¨ã€‚ + +ç§åŸŸç´ æåº“使用æµç¨‹å¦‚下: + +![Image Token: CWyVbkJYSoxmeExAhjCcYDOOnPe](images/CWyVbkJYSoxmeExAhjCcYDOOnPe.png) + +## ç´ æèµ„产库结构说明 + +> å•ä¸ªç´ ææ–‡ä»¶ä¸ºä¸€ä¸ª Asset(素æèµ„产),æ¯ä¸ª Asset 属于一个 Group(素æç»„åˆï¼‰ã€‚ +> +> * å¯ä½¿ç”¨ç´ æç»„自由管ç†ç´ æã€‚例如,å¯å°†åŒä¸€äººç‰©ã€å·¥ä½œå®¤æˆ–é¡¹ç›®ç»„çš„ç´ ææ”¾å…¥ä¸€ä¸ªç´ æç»„åˆè¿›è¡Œç®¡ç†ã€‚ +> +> * **ä»…å¯ä½¿ç”¨å·²å…¥åº“ç´ æçš„ ID (Asset ID)进行视频生æˆï¼ŒåŒä¸€å½¢è±¡æœªå…¥åº“ç´ ææ— æ³•使用。** +> +> * 仅需入库推ç†éœ€ä½¿ç”¨çš„ç´ æï¼Œä¸éœ€ä½¿ç”¨çš„ç´ æè¯·å‹¿å…¥åº“。 + +以å•人物形象为一素æç»„åˆä¸ºä¾‹ï¼š + +* ç´ æèµ„äº§ï¼šä¸€ä¸ªç´ ææ–‡ä»¶ï¼ˆå›¾ç‰‡ï¼‰ï¼Œæ˜¯æ–¹èˆŸ Seedance 2.0 系列模型å¯ç›´æŽ¥ç”¨äºŽæŽ¨ç†çš„å¯ä¿¡èµ„产。 + + * 举例:一张人物装造。 + + * 文件类型:图片 + + > **å•å¼ å›¾ç‰‡è¦æ±‚** + > + > * æ ¼å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gifã€heic/heif + > + > * 宽高比(宽/高): (0.4, 2.5) + > + > * 宽高长度(px):(300, 6000) + > + > * 大å°ï¼šå•张图片å°äºŽ 30 MB。 + + * 资产 ID 示例:`asset-20260310035119-h8tq4` + +![Image Token: NfNnbPdRUoLmRdxjoIUcwMvOnAf](images/NfNnbPdRUoLmRdxjoIUcwMvOnAf.png) + +* ç´ æèµ„产组: + + * å¯è‡ªç”±ç»„åˆç´ æï¼Œä»¥äººç‰©ã€å·¥ä½œå®¤ã€é¡¹ç›®ç»„等维度将素æè¿›è¡Œåˆ†ç»„管ç†ã€‚ + + * Group ID 示例:`group-20260310035119-*****` + + * 示例: + +![Image Token: E58BbrAcoo1E68xdZPecGDQgn1c](images/E58BbrAcoo1E68xdZPecGDQgn1c.jpeg) + +![Image Token: YX14bprrpoxvgXxHoABczW8EnNb](images/YX14bprrpoxvgXxHoABczW8EnNb.jpeg) + +![Image Token: YoLEbaqR6oic3mx2Ow6cQ1j2nnf](images/YoLEbaqR6oic3mx2Ow6cQ1j2nnf.jpeg) + + + +## 上传素æè‡³ç§åŸŸè™šæ‹Ÿäººåƒåº“ (API & 控制å°ï¼‰ + +您å¯å°†è‡ªæœ‰çš„虚拟形象上传至ç§åŸŸè™šæ‹Ÿäººåƒåº“。 + +> **警告:** +> +> 您需确ä¿ä¸Šä¼ çš„虚拟人åƒç¬¦åˆä»¥ä¸‹æ¡ä»¶ï¼š +> +> * æ‚¨åˆæ³•拥有该素æï¼Œå¹¶äº«æœ‰å®Œæ•´çš„使用åŠå¤„分æƒé™ã€‚ç´ æä¸åŒ…嫿œªèŽ·æŽˆæƒçš„ç¬¬ä¸‰æ–¹å•†æ ‡ã€æ ‡è¯†ç±»å†…容。 +> +> * ç´ æä¸å¾—ä¸Žä»»ä½•è‡ªç„¶äººè‚–åƒæˆ–形象雷åŒï¼Œç´ æä¸å­˜åœ¨æŠ„袭ã€ç›—用情形,ä¸ä¼šä¾µå®³ä»»ä½•第三方的人格æƒã€çŸ¥è¯†äº§æƒç­‰åˆæ³•æƒç›Šã€‚ +> +> * ç´ æä¸åŒ…å«è¿å法规ã€è¿èƒŒå…¬åºè‰¯ä¿—ã€å±å®³å›½å®¶å®‰å…¨çš„内容。 + +方舟将对您上传的素æè¿›è¡Œå®‰å…¨å®¡æ ¸ã€‚审核通过åŽï¼Œå³å¯åœ¨ä½“验中心和 API 中使用素æç”Ÿæˆè§†é¢‘。 + +您å¯ä½¿ç”¨ OpenAPI 或在体验中心上传虚拟素æã€‚ + +### é˜…è¯»å¹¶åŒæ„åè®® + +首次入库å‰ï¼Œéœ€æ‰“å¼€ [控制å°](https://console.volcengine.com/ark/region:ark+cn-beijing/overview?briefPage=0\&briefType=introduce\&type=new) > **开通管ç†** > **开通素æèµ„产库æƒé™ï¼Œ**阅è¯»å’ŒåŒæ„相关规则和å议: + +![Image Token: ZR4SbE6GColaYKxVTFZcSW1LnFc](images/ZR4SbE6GColaYKxVTFZcSW1LnFc.png) + +先创建 Asset Group, å†å‘ Group 中添加虚拟人åƒç´ æã€‚ + +> ç´ ææ ¼å¼çš„å…·ä½“è¦æ±‚,请å‚考[ç´ æåº“结构说明](https://bytedance.larkoffice.com/docx/MpHOdxYbwobmIWxk5rucBLranJb#share-V4mMdM92woylBlxML62c5Aelneh)。 + +### ä½¿ç”¨æŽ§åˆ¶å° + +1. 打开 [方舟控制å°](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo) > **我的素æèµ„产** > **æˆ‘çš„è™šæ‹Ÿäººåƒ > 添加虚拟人åƒ**,或左上方 **我的资产**。 + + ![Image Token: VolnbkTKkoQ81kxcksWc3Ts6nDf](images/VolnbkTKkoQ81kxcksWc3Ts6nDf.png) + + ![Image Token: R5wRbFyexonHeRxbIK1cs3ScnAd](images/R5wRbFyexonHeRxbIK1cs3ScnAd.png) + + + +2. 创建素æç»„åˆã€‚ + +3. å‘ç´ æç»„åˆä¸­ä¸Šä¼ ç´ æã€‚ + +### 使用 API + +先使用 `CreateAssetGroup` API 创建素æç»„åˆï¼Œå†ä½¿ç”¨ `CreateAsset` API å‘组åˆä¸­ä¸Šä¼ ç´ æã€‚请求示例: + +1. **创建素æç»„åˆ** + +> **注æ„**: +> +> * 调用素æèµ„产(Assets)API 接å£éœ€ä½¿ç”¨ Access Key 鉴æƒï¼Œè¯¦æƒ…å‚考 [API访问密钥管ç†](https://www.volcengine.com/docs/6257/64983?lang=zh)。 +> +> * API 傿•°ä¿¡æ¯è¯·å‚考[ Asset API å‚考 (WIP) 副本](https://bytedance.larkoffice.com/wiki/FtqVwjinYisraGkT5uncWyd0nEb)。 + +使用** POST` `**`CreateAssetGroup` 接å£åˆ›å»ºç´ æç»„åˆã€‚ + +在请求中传入: + +* **Name**:素æç»„åˆçš„å称。 + +* **Description**: ç´ æç»„åˆçš„æ–‡å­—æè¿°ã€‚ + +* **GroupType**: 选填,默认为 AIGC(虚拟人åƒç´ æï¼‰ã€‚ + +* **ProjectName**:选填,指定资æºé¡¹ç›®å称,默认为 default。一个项目中的资æºä»…å¯è¢«è¯¥é¡¹ç›®ä¸‹çš„æŽ¨ç†æŽ¥å…¥ç‚¹ä½¿ç”¨ï¼ŒèŽ·å–项目å称请å‚考[文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +> **注æ„** +> +> å¦‚æžœè¯·æ±‚ä¸­ä¸æŒ‡å®š **ProjectName**,默认将创建素æç»„至 **default** 项目中。 + +请求示例: + +**注æ„**:需使用 AK/SK 鉴æƒï¼Œè¯¦æƒ…å‚考 [API访问密钥管ç†](https://www.volcengine.com/docs/6257/64983?lang=zh)。 + +返回示例: + +* **上传素æ** + +使用 **POST **`CreateAsset`接å£ä¸Šä¼ ç´ æã€‚ + +在请求中æä¾›ï¼š + +* **GroupId**:必填,素æç»„åˆ ID + +* **URL**: 必填,图片å¯è®¿é—®çš„ URL + +* **AssetType**: 必填,仅支æŒä¸Šä¼ å›¾ç‰‡ç±»åž‹ç´ æï¼Œéœ€æŒ‡å®šä¸º **Image** + +* **Name**: 选填,素æå称,å¯ç”¨äºŽç®¡ç†ç´ æï¼Œå¦‚ç´ ææ–‡ä»¶å。 + +* **ProjectName**:选填,指定资æºé¡¹ç›®å称,默认为 **default**。一个项目中的资æºä»…å¯è¢«è¯¥é¡¹ç›®ä¸‹çš„æŽ¨ç†æŽ¥å…¥ç‚¹ä½¿ç”¨ï¼ŒèŽ·å–项目å称请å‚考[文档](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)。 + +> **注æ„** +> +> å¦‚æžœè¯·æ±‚ä¸­ä¸æŒ‡å®š **ProjectName**,则默认上传素æè‡³ **default** 项目中。您需使用该字段确ä¿å°†ç´ æä¸Šä¼ è‡³å¯¹åº”的项目中。 + +**注æ„**: + +* æ¯æ¬¡è¯·æ±‚ä¸Šä¼ ä¸€ä¸ªç´ ææ–‡ä»¶ã€‚ + +* 该请求返回素æ ID,å¯ä½¿ç”¨ GetAsset API 查看是å¦ä¸Šä¼ æˆåŠŸã€‚ + +返回示例: + +## 检索虚拟人åƒèµ„产 (API & 控制å°ï¼‰ + +您å¯ä½¿ç”¨ä»¥ä¸‹æ–¹å¼æ£€ç´¢è™šæ‹Ÿäººåƒèµ„产。 + +* **控制å°**:您å¯åœ¨ [方舟控制å°](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128\&tab=GenVideo) >** 我的** > **æˆ‘çš„è™šæ‹Ÿäººåƒ **中æœç´¢å’ŒæŸ¥çœ‹å·²ä¸Šä¼ çš„虚拟人åƒèµ„产。 + +* **API**: + + * **POST **`GetAsset `获å–å•个素æ + + * **POST **`ListAssets` 查询素æ + + * **POST **`ListAssetGroups` 查询素æç»„åˆä¿¡æ¯ + + + +### 获å–å•个素æä¿¡æ¯ + +å¯ä½¿ç”¨ **POST **GetAsset 获å–å•个素æä¿¡æ¯ï¼ŒæŒ‡å®šç´ æèµ„产 ID。 + +> **注æ„**:è¦èŽ·å–完整的 API 傿•°ã€é™æµç­‰ä¿¡æ¯ï¼Œè¯·æŸ¥çœ‹[ Asset API å‚考 (WIP) 副本](https://bytedance.larkoffice.com/docx/DZdUd9J3lo6JTGxDrjscv1g9nVg)。 + +返回示例: + +### 查询素æèµ„产 + +å¯ä½¿ç”¨ **POST **ListAssets 查询 Assets。 + +* æ”¯æŒæ ¹æ®ç»„åˆ ID (GroupId)ã€ç´ æçжæ€ï¼ˆStatuses)和素æå称(Nameï¼‰æŸ¥è¯¢ã€‚ç­›é€‰å‡ºç¬¦åˆæ‰€æœ‰æ¡ä»¶çš„ç´ æã€‚ + +* 支æŒä½¿ç”¨ Name 进行模糊æœç´¢ï¼ŒåŒæ—¶ä½¿ç”¨ GroupId 精确æœç´¢ï¼Œä¾¿äºŽæ£€ç´¢æ‰€éœ€çš„ç´ æã€‚ + +支æŒä½¿ç”¨ SortBy,SortOrder å¯¹ç»“æžœè¿›è¡ŒæŽ’åº + +> **注æ„**:获å–完整的 API å‚考文档,请查看[ Asset API å‚考 (WIP) 副本](https://bytedance.larkoffice.com/docx/DZdUd9J3lo6JTGxDrjscv1g9nVg)。 + +返回示例: + +### 查询素æç»„ + +使用 **POST **ListAssetGroups 查询素æç»„åˆä¿¡æ¯ã€‚ + +æ”¯æŒæ¨¡ç³Šæœç´¢ç´ æç»„åˆå称(Name)或æä¾›å¤šä¸ªç´ æç»„åˆï¼ˆGroupId)。 + +如有多个素æç»„,å¯ä½¿ç”¨ Name 字段进行模糊æœç´¢ã€‚ + +> **注æ„**:è¦èŽ·å–完整的 API å‚考文档,请查看[ Asset API å‚考 (WIP) 副本](https://bytedance.larkoffice.com/docx/DZdUd9J3lo6JTGxDrjscv1g9nVg)。 + +返回示例: + +## 示例:上传素æå¹¶ä½¿ç”¨ GetAsset 获å–ç´ æä¿¡æ¯ + +以下示例创建素æèµ„产åŽï¼ŒæŸ¥è¯¢èµ„产 Status å¹¶æ ¹æ®çжæ€ï¼Œåˆ¤æ–­æ˜¯å¦ç»§ç»­æŸ¥è¯¢æˆ–返回对应结果。 + +ä»£ç æ‰§è¡Œä»¥ä¸‹é€»è¾‘: + +1. createAsset: 上传资æºï¼ŒèŽ·å– AssetId + +2. waitForAssetActive:开始查询,循环调用 getAssetStatus 查询当å‰èµ„äº§çŠ¶æ€ + +3. æ ¹æ® Status 判断 + + * Processing → 继续轮询 + + * Active → 返回 URL(结æŸï¼‰çжæ€ä¸º **Active** åŽï¼Œå¯ä½¿ç”¨è¯¥ç´ æ Asset ID (URIæ ¼å¼) 进行视频生æˆï¼Œå¦‚何使用人åƒç´ æç”Ÿæˆè§†é¢‘,详è§[下文](https://bytedance.larkoffice.com/wiki/RtHgwpJgviwFXLkQ9hLcRooEnVe#share-GrbXdVvYjonbMkxQWHEcGf2Inlf)。 + + * Failed → 返回错误(结æŸï¼‰ + +4. 返回结果并打å°ç»“æžœ + +查询结果示æ„如下: + + + +## 使用人åƒç´ æç”Ÿæˆè§†é¢‘ + +在获å–ç´ æ Asset IDåŽï¼Œå¯ä½¿ç”¨ç§åŸŸäººåƒç´ æç”Ÿæˆè§†é¢‘。效果预览åŠä½¿ç”¨æ–¹å¼è¯·å‚考下文。 + +### 效果预览 + +| 输入:文本 | 输入:虚拟人åƒã€å›¾ç‰‡ | 输出 | +| ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -- | +| **图片1**中美妆åšä¸»ç”¨ä¸­æ–‡è¿›è¡Œä»‹ç»ï¼Œå¦†å®¹æ”¹ä¸ºæ˜Žè‰³å¤§æ°”,去掉脸部å光,笑容甜美,近景镜头,手æŒ**图片2**çš„é¢éœœé¢å‘镜头展示,清新简约背景,元气甜美风格。åšä¸»å°è¯ï¼šæŒ–到本命é¢éœœäº†ï¼è´¨åœ°åƒäº‘æœµä¸€æ ·è½¯ç³¯ï¼Œä¸€æŠ¹å°±å¸æ”¶ï¼Œç†¬å¤œæ€¥æ•‘ã€è¡¥æ°´ä¿æ¹¿å…¨æžå®šï¼Œç´ é¢œéƒ½è‡ªå¸¦æŸ”光感。 | ![Image Token: HX4abuktdoOdZgxrqbxcNBlznSh](images/HX4abuktdoOdZgxrqbxcNBlznSh.png)![Image Token: MHRTb8420oORTqxTohYcrFkRnhc](images/MHRTb8420oORTqxTohYcrFkRnhc.jpeg) | | + +### è§†é¢‘ç”Ÿæˆ + +在 Video Generation API çš„ **content.<模æ€>\_url.url** 字段中使用 ç´ æ URI 生æˆè§†é¢‘。 + +> 资产 URI 拼接方å¼ï¼š`Asset://`** + +具体方å¼è¯·å‚考[ ã€ç”³è¯·æƒé™å¡«å®¢æˆ·å称】Seedance 2.0 & 2.0 fast API文档(邀测用户版)](https://bytedance.larkoffice.com/wiki/SANpwJ9bgiKgrykLaMTcAB0InWc#share-ONSwd51ezoXCJqxkAm2cIC61nMX)。 + +示例代ç ï¼š + +## 常è§é—®é¢˜ + +### 1. 为什么素æä¸Šä¼ æˆåŠŸåŽï¼Œæ— æ³•使用素æç”Ÿæˆè§†é¢‘或获å–ç´ æä¿¡æ¯ï¼Ÿ + +ç´ æåº“按**[项目](https://www.volcengine.com/docs/82379/1359411?lang=zh#03ec4a65)(Project)隔离**。 + +* åœ¨è§†é¢‘ç”Ÿæˆæ—¶ï¼Œå¿…须使用**ç´ ææ‰€åœ¨é¡¹ç›®**ä¸­çš„æŽ¨ç†æŽ¥å…¥ç‚¹è¿›è¡ŒæŽ¨ç†ã€‚ + +* 如果素æä¸Šä¼ æˆåŠŸï¼Œä½†ä½¿ç”¨èŽ·å–ç´ ææŽ¥å£èŽ·å–ç´ æå¤±è´¥ï¼Œå¯èƒ½æ˜¯å› ä¸ºè°ƒç”¨ä¸Šä¼ ç´ æ(CreateAsset)和获å–ç´ ææŽ¥å£æ—¶ä¼ å…¥äº†ä¸åŒçš„ **ProjectName**。 + + * **ProjectName** 默认值为 `default`,å³å¦‚æžœä¸æŒ‡å®šè¯¥å­—段,则默认将资æºåˆ›å»ºè‡³ `default` 项目中。 + + * 建议在åŒä¸€ä¸ªé¡¹ç›®ä¸­ç®¡ç†ç´ æã€‚ + +### 2. 怎样管ç†ç”¨æˆ·å¯¹ç´ æåº“çš„æƒé™ï¼Ÿ + +您å¯ä½¿ç”¨[访问控制](https://console.volcengine.com/iam/identitymanage/user) (IAM)精细化管ç†ç”¨æˆ·æ“作素æåº“çš„æƒé™ã€‚坿Œ‰ä»¥ä¸‹æ–¹å¼è®¾ç½®ï¼š + +1. **创建自定义策略** + + 1. 打开[访问控制](https://console.volcengine.com/iam/policymanage) >** 新建自定义策略** + + 2. 输入策略å称。 + + 3. 切æ¢åˆ° **JSON编辑器**,将下方自定义策略粘贴至编辑器中,点击 **æäº¤** ä¿å­˜ã€‚ + +![Image Token: F0bnb6AanolkCVxjbTdcKMOenkh](images/F0bnb6AanolkCVxjbTdcKMOenkh.png) + +* **为用户/用户组赋æƒ** + + 1. 点击 **用户管ç†** > **用户**/**用户组**,选择需è¦èµ‹æƒçš„用户或用户组,点击å³ä¾§çš„ **添加æƒé™ã€‚** + + 2. 在 **授æƒç­–ç•¥** 中选择**步骤 1** 中创建的策略。 + + 3. (å¯é€‰ï¼‰åœ¨ **é™åˆ¶åˆ°é¡¹ç›®èµ„æº **中选择策略应用的项目。 + + 4. 点击 **æäº¤ã€‚** + +完æˆä¸Šè¿°æ“作åŽï¼Œè¯¥ç”¨æˆ·/用户组å³å¯åœ¨å¯¹åº”项目中管ç†ç´ æã€‚ + +关于 IAM 的更多信æ¯ï¼Œè¯·å‚考[访问控制](http://volcengine.com/docs/6257?lang=zh)。 + + + diff --git a/docs/API文档/关于ç§å­å€¼.md b/docs/API文档/关于ç§å­å€¼.md new file mode 100644 index 0000000..2951acd --- /dev/null +++ b/docs/API文档/关于ç§å­å€¼.md @@ -0,0 +1,487 @@ +`POST https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks` [ ](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)[è¿è¡Œ](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01) +本文介ç»åˆ›å»ºè§†é¢‘生æˆä»»åŠ¡ API çš„è¾“å…¥è¾“å‡ºå‚æ•°ï¼Œä¾›æ‚¨ä½¿ç”¨æŽ¥å£æ—¶æŸ¥é˜…字段å«ä¹‰ã€‚æ¨¡åž‹ä¼šä¾æ®ä¼ å…¥çš„å›¾ç‰‡åŠæ–‡æœ¬ä¿¡æ¯ç”Ÿæˆè§†é¢‘,待生æˆå®ŒæˆåŽï¼Œæ‚¨å¯ä»¥æŒ‰æ¡ä»¶æŸ¥è¯¢ä»»åŠ¡å¹¶èŽ·å–生æˆçš„视频。 +:::warning +Seedance 2.0 模型目å‰ä»…æ”¯æŒ [控制å°ä½“验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128&tab=GenVideo) 在å…è´¹é¢åº¦å†…ä½“éªŒï¼Œæš‚ä¸æ”¯æŒ API 调用,敬请期待。 + +::: +**ä¸åŒæ¨¡åž‹æ”¯æŒçš„视频生æˆèƒ½åŠ›ç®€ä»‹** + +* **Seedance 1.5 pro==^new^==** ** ** **==^有声视频^==** **(自定义是å¦åŒ…å«éŸ³é¢‘)** + * 图生视频\-é¦–å°¾å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+尾帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * 图生视频\-é¦–å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * æ–‡ç”Ÿè§†é¢‘ï¼Œæ ¹æ®æ‚¨è¾“入的++文本æç¤ºè¯+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 +* **Seedance 1.0 pro** + * 图生视频\-é¦–å°¾å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+尾帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * 图生视频\-é¦–å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * æ–‡ç”Ÿè§†é¢‘ï¼Œæ ¹æ®æ‚¨è¾“入的++文本æç¤ºè¯+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 +* **Seedance 1.0 pro fast** + * 图生视频\-é¦–å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * æ–‡ç”Ÿè§†é¢‘ï¼Œæ ¹æ®æ‚¨è¾“入的++文本æç¤ºè¯+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 +* **Seedance 1.0 lite** + * **doubao\-seedance\-1\-0\-lite\-t2v:** æ–‡ç”Ÿè§†é¢‘ï¼Œæ ¹æ®æ‚¨è¾“入的++文本æç¤ºè¯+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * **doubao\-seedance\-1\-0\-lite\-i2v:** + * 图生视频\-å‚è€ƒå›¾ï¼Œæ ¹æ®æ‚¨è¾“入的**++å‚考图片(1\-4张)++ ** +++文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+ 傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * 图生视频\-é¦–å°¾å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+尾帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + * 图生视频\-é¦–å¸§ï¼Œæ ¹æ®æ‚¨è¾“入的++首帧图片+文本æç¤ºè¯ï¼ˆå¯é€‰ï¼‰+傿•°ï¼ˆå¯é€‰ï¼‰++ 生æˆç›®æ ‡è§†é¢‘。 + + +Tips:一键展开折å ï¼Œå¿«é€Ÿæ£€ç´¢å†…容 +打开页é¢å³ä¸Šè§’开关,**ctrl ** + **f** 坿£€ç´¢é¡µé¢å†…所有内容。 +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_cae7ddb0e1977b68b353f17897b8574c.png) + + +```mixin-react +return ( + +`}> + +![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_2abecd05ca2779567c6d32f0ddc7874d.png =20x) [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a5fdd3028d35cc512a10bd71b982b6eb.png =20x) [模型计费](https://www.volcengine.com/docs/82379/1544106?redirect=1&lang=zh#02affcb8) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_afbcf38bdec05c05089d5de5c3fd8fc8.png =20x) [API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D) + ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_57d0bca8e0d122ab1191b40101b5df75.png =20x) [调用教程](https://www.volcengine.com/docs/82379/1366799) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f45b5cd5863d1eed3bc3c81b9af54407.png =20x) [æŽ¥å£æ–‡æ¡£](https://www.volcengine.com/docs/82379/1520758) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_1609c71a747f84df24be1e6421ce58f0.png =20x) [常è§é—®é¢˜](https://www.volcengine.com/docs/82379/1359411) ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bef4bc3de3535ee19d0c5d6c37b0ffdd.png =20x) [开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false) +`}>); +``` + + +--- + + + +## è¯·æ±‚å‚æ•° +> 跳转 [å“åº”å‚æ•°](#y2hhTyHB) + + +### 请求体 + +--- + + +**model** `string` %%require%% +您需è¦è°ƒç”¨çš„æ¨¡åž‹çš„ ID (Model ID),[开通模型æœåŠ¡](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false),并[查询 Model ID](https://www.volcengine.com/docs/82379/1330310) 。 +您也å¯é€šè¿‡ Endpoint ID æ¥è°ƒç”¨æ¨¡åž‹ï¼Œè޷得陿µã€è®¡è´¹ç±»åž‹ï¼ˆå‰ä»˜è´¹/åŽä»˜è´¹ï¼‰ã€è¿è¡ŒçŠ¶æ€æŸ¥è¯¢ã€ç›‘控ã€å®‰å…¨ç­‰é«˜çº§èƒ½åŠ›ï¼Œå¯å‚考[èŽ·å– Endpoint ID](https://www.volcengine.com/docs/82379/1099522)。 + +--- + + +**content** `object[]` %%require%% +输入给模型,生æˆè§†é¢‘的信æ¯ï¼Œæ”¯æŒæ–‡æœ¬ã€å›¾ç‰‡å’Œè§†é¢‘(样片,Draft 视频)格å¼ã€‚支æŒä»¥ä¸‹å‡ ç§ç»„åˆï¼š + +* 文本 +* 文本+图片 +* 视频:其中视频指已æˆåŠŸç”Ÿæˆçš„æ ·ç‰‡è§†é¢‘,模型å¯åŸºäºŽæ ·ç‰‡ç”Ÿæˆé«˜è´¨é‡æ­£å¼è§†é¢‘。 + + +ä¿¡æ¯ç±»åž‹ + +--- + + +**文本信æ¯** `object` +输入给模型生æˆè§†é¢‘的内容,文本内容部分。 + +属性 + +--- + + +content.**type ** `string` %%require%% +输入内容的类型,此处应为 `text`。 + +--- + + +content.**text ** `string` %%require%% +输入给模型的文本æç¤ºè¯ï¼Œæè¿°æœŸæœ›ç”Ÿæˆçš„视频。 +支æŒä¸­è‹±æ–‡ã€‚建议中文ä¸è¶…过500字,英文ä¸è¶…过1000è¯ã€‚字数过多信æ¯å®¹æ˜“分散,模型å¯èƒ½å› æ­¤å¿½ç•¥ç»†èŠ‚ï¼Œåªå…³æ³¨é‡ç‚¹ï¼Œé€ æˆè§†é¢‘缺失部分元素。æç¤ºè¯çš„æ›´å¤šä½¿ç”¨æŠ€å·§è¯·å‚è§ [Seedance æç¤ºè¯æŒ‡å—](https://www.volcengine.com/docs/82379/1587797)。 + + +--- + + +**图片信æ¯** `object` +输入给模型生æˆè§†é¢‘的内容,图片信æ¯éƒ¨åˆ†ã€‚ + +属性 + +--- + + +content.**type ** `string` %%require%% +输入内容的类型,此处应为 `image_url`。支æŒå›¾ç‰‡URL或图片 Base64 ç¼–ç ã€‚ + +--- + + +content.**image_url ** `object` %%require%% +输入给模型的图片对象。 + +属性 + +--- + + +content.image_url.**url ** `string` %%require%% +图片信æ¯ï¼Œå¯ä»¥æ˜¯å›¾ç‰‡URL或图片 Base64 ç¼–ç ã€‚ + +* 图片URL:请确ä¿å›¾ç‰‡URLå¯è¢«è®¿é—®ã€‚ +* Base64ç¼–ç ï¼šè¯·éµå¾ªæ­¤æ ¼å¼`data:image/<图片格å¼>;base64,`ï¼Œæ³¨æ„ `<图片格å¼>` 需å°å†™ï¼Œå¦‚ `data:image/png;base64,{base64_image}`。 + +:::tip +ä¼ å…¥å›¾ç‰‡éœ€è¦æ»¡è¶³ä»¥ä¸‹æ¡ä»¶ï¼š + +* 图片格å¼ï¼šjpegã€pngã€webpã€bmpã€tiffã€gif。其中,Seedance 1.5 pro æ–°å¢žæ”¯æŒ heic å’Œ heif。 +* 宽高比(宽/高): (0.4, 2.5) +* 宽高长度(px):(300, 6000) +* 大å°ï¼šå°äºŽ 30 MB + +::: + +--- + + +content.**role ** `string` `æ¡ä»¶å¿…å¡«` +图片的ä½ç½®æˆ–用途。 +:::warning +首帧图生视频ã€é¦–尾帧图生视频ã€å‚考图生视频为 3 ç§äº’æ–¥çš„åœºæ™¯ï¼Œä¸æ”¯æŒæ··ç”¨ã€‚ + +::: +图生视频\-首帧 + +* **æ”¯æŒæ¨¡åž‹ï¼š** 所有图生视频模型 +* **字段roleå–值:** 需è¦ä¼ å…¥1个image_url对象,且字段roleå¯ä¸å¡«ï¼Œæˆ–字段role为:first_frame + + +图生视频\-首尾帧 + +* **æ”¯æŒæ¨¡åž‹ï¼š** Seedance 1.5 proã€Seedance 1.0 proã€Seedance 1.0 lite i2v +* **字段roleå–值:** 需è¦ä¼ å…¥2个image_url对象,且字段role必填。 + * 首帧图片对应的字段role为:first_frame + * 尾帧图片对应的字段role为:last_frame + +:::tip +传入的首尾帧图片å¯ç›¸åŒã€‚首尾帧图片的宽高比ä¸ä¸€è‡´æ—¶ï¼Œä»¥é¦–帧图片为主,尾帧图片会自动è£å‰ªé€‚é…。 + +::: + +图生视频\-å‚考图 + +* **æ”¯æŒæ¨¡åž‹ï¼š** Seedance 1.0 lite i2v +* **字段roleå–值:** 需è¦ä¼ å…¥1~4个image_url对象,且字段role必填。 + * æ¯å¼ å‚考图片对应的字段roleå‡ä¸ºï¼šreference_image + +:::tip +å‚考图生视频功能的文本æç¤ºè¯ï¼Œå¯ä»¥ç”¨è‡ªç„¶è¯­è¨€æŒ‡å®šå¤šå¼ å›¾ç‰‡çš„组åˆã€‚但若想有更好的指令éµå¾ªæ•ˆæžœï¼Œ**推è使用“[图1]xxx,[图2]xxxâ€çš„æ–¹å¼æ¥æŒ‡å®šå›¾ç‰‡**。 +示例1:戴ç€çœ¼é•œç©¿ç€è“色Tæ¤çš„男生和柯基å°ç‹—,å在è‰åªä¸Šï¼Œ3Då¡é€šé£Žæ ¼ +示例2:[图1]戴ç€çœ¼é•œç©¿ç€è“色Tæ¤çš„男生和[图2]的柯基å°ç‹—,å在[图3]çš„è‰åªä¸Šï¼Œ3Då¡é€šé£Žæ ¼ + +::: + + +--- + + +**样片信æ¯==^new^==** ** ** `object` +基于样片任务 IDï¼Œç”Ÿæˆæ­£å¼è§†é¢‘。仅 Seedance 1.5 pro 支æŒè¯¥åŠŸèƒ½ã€‚[阅读](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8)[文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) èŽ·å– draft 功能的使用教程和注æ„事项。 + +属性 + +--- + + +content.**type ** `string` %%require%% +输入内容的类型,此处应为 `draft_task`。 + +--- + + +content.**draft_task** ** ** `object` %%require%% +输入给模型的样片任务。 + +属性 + +--- + + +content.draft_task.**id ** `string` %%require%% +样片任务 ID。平å°å°†è‡ªåЍå¤ç”¨ Draft 视频使用的用户输入(**modelã€** content.**textã€** content.**image_urlã€generate_audioã€seedã€ratioã€durationã€camera_fixed ** ï¼‰ï¼Œç”Ÿæˆæ­£å¼è§†é¢‘ã€‚å…¶ä½™å‚æ•°æ”¯æŒæŒ‡å®šï¼Œä¸æŒ‡å®šå°†ä½¿ç”¨æœ¬æ¨¡åž‹çš„默认值。 +使用分为两步:Step1: 调用本接å£ç”Ÿæˆ Draft 视频。Step2: 如果确认 Draft 视频符åˆé¢„期,å¯åŸºäºŽ Step1 返回的 Draft 视频任务 ID,调用本接å£ç”Ÿæˆæœ€ç»ˆè§†é¢‘。[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获å–详细教程。 + + + + +--- + + +**callback_url** `string` +填写本次生æˆä»»åŠ¡ç»“æžœçš„å›žè°ƒé€šçŸ¥åœ°å€ã€‚当视频生æˆä»»åŠ¡æœ‰çŠ¶æ€å˜åŒ–æ—¶ï¼Œæ–¹èˆŸå°†å‘æ­¤åœ°å€æŽ¨é€ POST 请求。 +回调请求内容结构与[查询任务API](https://www.volcengine.com/docs/82379/1521309)的返回体一致。 +回调返回的 status 包括以下状æ€ï¼š + +* queued:排队中。 +* running:任务è¿è¡Œä¸­ã€‚ +* succeeded: 任务æˆåŠŸã€‚ï¼ˆå¦‚å‘é€å¤±è´¥ï¼Œå³5秒内没有接收到æˆåŠŸå‘é€çš„ä¿¡æ¯ï¼Œå›žè°ƒä¸‰æ¬¡ï¼‰ +* failed:任务失败。(如å‘é€å¤±è´¥ï¼Œå³5秒内没有接收到æˆåŠŸå‘é€çš„ä¿¡æ¯ï¼Œå›žè°ƒä¸‰æ¬¡ï¼‰ +* expired:任务超时,å³ä»»åŠ¡å¤„äºŽ**è¿è¡Œä¸­æˆ–排队中**状æ€è¶…过过期时间。å¯é€šè¿‡ **execution_expires_after ** 字段设置过期时间。 + + +--- + + +**return_last_frame** `boolean` `默认值 false` + +* true:返回生æˆè§†é¢‘的尾帧图åƒã€‚设置为 `true` åŽï¼Œå¯é€šè¿‡ [查询视频生æˆä»»åŠ¡æŽ¥å£](https://www.volcengine.com/docs/82379/1521309) 获å–视频的尾帧图åƒã€‚尾帧图åƒçš„æ ¼å¼ä¸º png,宽高åƒç´ å€¼ä¸Žç”Ÿæˆçš„è§†é¢‘ä¿æŒä¸€è‡´ï¼Œæ— æ°´å°ã€‚ + ä½¿ç”¨è¯¥å‚æ•°å¯å®žçŽ°ç”Ÿæˆå¤šä¸ªè¿žç»­è§†é¢‘:以上一个生æˆè§†é¢‘的尾帧作为下一个视频任务的首帧,快速生æˆå¤šä¸ªè¿žç»­è§†é¢‘ï¼Œè°ƒç”¨ç¤ºä¾‹è¯¦è§ [教程](https://www.volcengine.com/docs/82379/1366799?lang=zh#141cf7fa)。 +* false:ä¸è¿”回生æˆè§†é¢‘的尾帧图åƒã€‚ + + +--- + + +**service_tier** `string` `默认值 default` +> 䏿”¯æŒä¿®æ”¹å·²æäº¤ä»»åŠ¡çš„æœåŠ¡ç­‰çº§ + +æŒ‡å®šå¤„ç†æœ¬æ¬¡è¯·æ±‚çš„æœåŠ¡ç­‰çº§ç±»åž‹ï¼Œæžšä¸¾å€¼ï¼š + +* defaultï¼šåœ¨çº¿æŽ¨ç†æ¨¡å¼ï¼ŒRPM å’Œå¹¶å‘æ•°é…é¢è¾ƒä½Žï¼ˆè¯¦è§ [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)),适åˆå¯¹æŽ¨ç†æ—¶æ•ˆæ€§è¦æ±‚较高的场景。 +* flexï¼šç¦»çº¿æŽ¨ç†æ¨¡å¼ï¼ŒTPD é…颿›´é«˜ï¼ˆè¯¦è§ [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)),价格为在线推ç†çš„ 50%, 适åˆå¯¹æŽ¨ç†æ—¶å»¶è¦æ±‚ä¸é«˜çš„场景。 + + +--- + + +**execution_expires_after** ** ** `integer` `默认值 172800` +任务超时阈值。指定任务æäº¤åŽçš„过期时间(å•ä½ï¼šç§’),从 **created at** 时间戳开始计算。默认值 172800 ç§’ï¼Œå³ 48 å°æ—¶ã€‚å–值范围:[3600,259200]。 +ä¸è®ºä½¿ç”¨å“ªç§ **service_tier**,都建议根æ®ä¸šåŠ¡åœºæ™¯è®¾ç½®åˆé€‚的超时时间。超过该时间åŽä»»åŠ¡ä¼šè¢«è‡ªåŠ¨ç»ˆæ­¢ï¼Œå¹¶æ ‡è®°ä¸º`expired`状æ€ã€‚ + +--- + + +**generate_audio==^new^==** ** ** `boolean` `默认值 true` +> ä»… Seedance 1.5 pro æ”¯æŒ + +控制生æˆçš„视频是å¦åŒ…å«ä¸Žç”»é¢åŒæ­¥çš„声音。 + +* true:模型输出的视频包å«åŒæ­¥éŸ³é¢‘。Seedance 1.5 pro 能够基于文本æç¤ºè¯ä¸Žè§†è§‰å†…容,自动生æˆä¸Žä¹‹åŒ¹é…的人声ã€éŸ³æ•ˆåŠèƒŒæ™¯éŸ³ä¹ã€‚建议将对è¯éƒ¨åˆ†ç½®äºŽåŒå¼•å·å†…ï¼Œä»¥ä¼˜åŒ–éŸ³é¢‘ç”Ÿæˆæ•ˆæžœã€‚例如:男人å«ä½å¥³äººè¯´ï¼šâ€œä½ è®°ä½ï¼Œä»¥åŽä¸å¯ä»¥ç”¨æ‰‹æŒ‡æŒ‡æœˆäº®ã€‚†+* false:模型输出的视频为无声视频。 + + +--- + + +**draft==^new^==** ** ** `boolean` `默认值 false` +> ä»… Seedance 1.5 pro æ”¯æŒ + +控制是å¦å¼€å¯æ ·ç‰‡æ¨¡å¼ã€‚[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获å–使用教程和注æ„事项。 + +* trueï¼šå¼€å¯æ ·ç‰‡æ¨¡å¼ï¼Œç”Ÿæˆä¸€æ®µé¢„览视频,快速验è¯åœºæ™¯ç»“æž„ã€é•œå¤´è°ƒåº¦ã€ä¸»ä½“动作与 prompt æ„图是å¦ç¬¦åˆé¢„期。消耗 token æ•°è¾ƒæ­£å¸¸è§†é¢‘æ›´å°‘ï¼Œä½¿ç”¨æˆæœ¬æ›´ä½Žã€‚ +* false:关闭样片模å¼ï¼Œæ­£å¸¸ç”Ÿæˆä¸€æ®µè§†é¢‘。 + +:::tip +开坿 ·ç‰‡æ¨¡å¼åŽï¼Œå°†ä½¿ç”¨ 480p åˆ†è¾¨çŽ‡ç”Ÿæˆ Draft è§†é¢‘ï¼ˆä½¿ç”¨å…¶ä»–åˆ†è¾¨çŽ‡ä¼šæŠ¥é”™ï¼‰ï¼Œä¸æ”¯æŒè¿”å›žå°¾å¸§åŠŸèƒ½ï¼Œä¸æ”¯æŒç¦»çº¿æŽ¨ç†åŠŸèƒ½ã€‚ + +::: +--- + + +:::warning éƒ¨åˆ†å‚æ•°å‡çº§è¯´æ˜Ž + +* **对于 resolutionã€ratioã€durationã€framesã€seedã€camera_fixedã€watermark 傿•°ï¼Œå¹³å°å‡çº§äº†å‚数传入方å¼ï¼Œç¤ºä¾‹å¦‚下。Seedance 1.0\-1.5 系列模型ä¾ç„¶å…¼å®¹æ”¯æŒæ—§æ–¹å¼ã€‚** +* ä¸åŒæ¨¡åž‹ï¼Œå¯èƒ½å¯¹åº”支æŒä¸åŒçš„傿•°ä¸Žå–å€¼ï¼Œè¯¦è§ [输出视频格å¼](https://www.volcengine.com/docs/82379/1366799?lang=zh#9fe4cce0)ã€‚å½“è¾“å…¥çš„å‚æ•°æˆ–å–值ä¸ç¬¦åˆæ‰€é€‰çš„æ¨¡åž‹æ—¶ï¼Œè¯¥å‚æ•°å°†è¢«å¿½ç•¥æˆ–è§¦å‘æŠ¥é”™ï¼š + * æ–°æ–¹å¼ï¼šåœ¨ request body ä¸­ç›´æŽ¥ä¼ å…¥å‚æ•°ã€‚此方å¼ä¸º**强校验,** è‹¥å‚æ•°å¡«å†™é”™è¯¯ï¼Œæ¨¡åž‹ä¼šè¿”回错误æç¤ºã€‚ + * æ—§æ–¹å¼ï¼šåœ¨æ–‡æœ¬æç¤ºè¯åŽè¿½åŠ  \-\-[parameters]。此方å¼ä¸º**弱校验,** è‹¥å‚æ•°å¡«å†™é”™è¯¯ï¼Œæ¨¡åž‹å°†è‡ªåŠ¨ä½¿ç”¨é»˜è®¤å€¼ä¸”ä¸ä¼šæŠ¥é”™ã€‚ + + +::: +**æ–°æ–¹å¼ï¼ˆæŽ¨è):在 request body ä¸­ç›´æŽ¥ä¼ å…¥å‚æ•°** +```JSON +... + // Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed. + "model": "doubao-seedance-1-5-pro-251215", + "content": [ + { + "type": "text", + "text": "å°çŒ«å¯¹ç€é•œå¤´æ‰“哈欠" + } + ], + // All parameters must be written in full; abbreviations are not supported + "resolution": "720p", + "ratio":"16:9", + "duration": 5, + // "frames": 29, Either duration or frames is required + "seed": 11, + "camera_fixed": false, + "watermark": true +... +``` + + + + +**æ—§æ–¹å¼ï¼šåœ¨æ–‡æœ¬æç¤ºè¯åŽè¿½åŠ  \-\-[parameters]** +```JSON +... + // Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed. + "model": "doubao-seedance-1-5-pro-251215", + "content": [ + { + "type": "text", + "text": "å°çŒ«å¯¹ç€é•œå¤´æ‰“哈欠 --rs 720p --rt 16:9 --dur 5 --seed 11 --cf false --wm true" + // "text": "å°çŒ«å¯¹ç€é•œå¤´æ‰“哈欠 --resolution 720p --ratio 16:9 --duration 5 --seed 11 --camerafixed false --watermark true" + } + ] +... +``` + + + + +--- + + +**resolution ** `string` +> Seedance 1.5 proã€Seedance 1.0 lite 默认值:`720p` +> Seedance 1.0 pro & pro\-fast 默认值:`1080p` + +视频分辨率,枚举值: + +* 480p +* 720p +* 1080p:å‚è€ƒå›¾åœºæ™¯ä¸æ”¯æŒ + + +--- + + +**ratio ** `string` +> 文生视频:默认值 `16:9`( Seedance 1.5 Pro 默认值为 `adaptive`) +> 图生视频:默认值 `adaptive`(å‚考图生视频场景默认值为 `16:9`) + +生æˆè§†é¢‘的宽高比例。ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼è§ä¸‹æ–¹è¡¨æ ¼ã€‚ + +* 16:9 +* 4:3 +* 1:1 +* 3:4 +* 9:16 +* 21:9 +* adaptive:根æ®è¾“入自动选择最åˆé€‚的宽高比(详è§ä¸‹æ–‡è¯´æ˜Žï¼‰ + +:::warning **adaptive ** 适é…规则 +当é…ç½® **ratio** 为 `adaptive` 时,模型会根æ®ç”Ÿæˆåœºæ™¯è‡ªåЍ适é…宽高比;实际生æˆçš„视频宽高比å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **ratio** 字段获å–。 + +* 文生视频场景:根æ®è¾“入的æç¤ºè¯ï¼Œè‡ªåŠ¨é€‰æ‹©æœ€åˆé€‚的宽高比(仅 Seedance 1.5 Pro 支æŒï¼‰ã€‚ +* 图生视频场景: + * å‚è€ƒå›¾ç”Ÿè§†é¢‘ï¼šä¸æ”¯æŒé…ç½® **ratio** 为 `adaptive`。 + * 首帧 / 首尾帧生视频:根æ®ä¸Šä¼ çš„首帧图片比例,自动选择最åˆé€‚的宽高比。 + + +::: +**ä¸åŒå®½é«˜æ¯”对应的宽高åƒç´ å€¼** +Note:图生视频,选择的宽高比与您上传的图片宽高比ä¸ä¸€è‡´æ—¶ï¼Œæ–¹èˆŸä¼šå¯¹æ‚¨çš„图片进行è£å‰ªï¼Œè£å‰ªæ—¶ä¼šå±…中è£å‰ªï¼Œè¯¦ç»†è§„åˆ™è§ [图片è£å‰ªè§„则](https://www.volcengine.com/docs/82379/1366799?lang=zh#f76aafc8)。 + +|分辨率 |宽高比|宽高åƒç´ å€¼|宽高åƒç´ å€¼|\ +| | |Seedance 1.0 系列 |Seedance 1.5 pro | +|---|---|---|---| +|480p |16:9 |864×480 |864×496 | +|^^|4:3 |736×544 |752×560 | +|^^|1:1 |640×640 |640×640 | +|^^|3:4 |544×736 |560×752 | +|^^|9:16 |480×864 |496×864 | +|^^|21:9 |960×416 |992×432 | +|720p |16:9 |1248×704 |1280×720 | +|^^|4:3 |1120×832 |1112×834 | +|^^|1:1 |960×960 |960×960 | +|^^|3:4 |832×1120 |834×1112 | +|^^|9:16 |704×1248 |720×1280 | +|^^|21:9 |1504×640 |1470×630 | +|1080p |16:9 |1920×1088 |1920×1080 |\ +|> 1.0 lite å‚è€ƒå›¾åœºæ™¯ä¸æ”¯æŒ | | | | +|^^|4:3 |1664×1248 |1664×1248 | +|^^|1:1 |1440×1440 |1440×1440 | +|^^|3:4 |1248×1664 |1248×1664 | +|^^|9:16 |1088×1920 |1080×1920 | +|^^|21:9 |2176×928 |2206×946 | + + + + +--- + + +**duration** `integer` `默认值 5` +> duration å’Œ frames 二选一å³å¯ï¼Œframes 的优先级高于 durationã€‚å¦‚æžœæ‚¨å¸Œæœ›ç”Ÿæˆæ•´æ•°ç§’的视频,建议指定 duration。 + +生æˆè§†é¢‘时长,å•ä½ï¼šç§’ã€‚æ”¯æŒ 2~12 秒。 +:::warning +Seedance 1.5 pro 支æŒä¸¤ç§é…置方法 + + * æŒ‡å®šå…·ä½“æ—¶é•¿ï¼šæ”¯æŒ [4,12] 范围内的任一整数。 + * 䏿Œ‡å®šå…·ä½“ç”Ÿæˆæ—¶é•¿ï¼šè®¾ç½®ä¸º `-1`,表示由模型在 [4,12] 范围内自主选择åˆé€‚的视频长度(整数秒)。实际生æˆè§†é¢‘的时长å¯é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **duration** 字段获å–。注æ„视频时长与计费相关,请谨慎设置。 + + +::: +--- + + +**frames** `integer` +> Seedance 1.5 pro æš‚ä¸æ”¯æŒ +> duration å’Œ frames 二选一å³å¯ï¼Œframes 的优先级高于 duration。如果您希望生æˆå°æ•°ç§’的视频,建议指定 frames。 + +生æˆè§†é¢‘的帧数。通过指定帧数,å¯ä»¥çµæ´»æŽ§åˆ¶ç”Ÿæˆè§†é¢‘的长度,生æˆå°æ•°ç§’的视频。 +由于 frames çš„å–值é™åˆ¶ï¼Œä»…èƒ½æ”¯æŒæœ‰é™å°æ•°ç§’ï¼Œæ‚¨éœ€è¦æ ¹æ®å…¬å¼æŽ¨ç®—最接近的帧数。 + +* 计算公å¼ï¼šå¸§æ•° = æ—¶é•¿ × 帧率(24)。 +* å–å€¼èŒƒå›´ï¼šæ”¯æŒ [29, 289] 区间内所有满足 `25 + 4n` æ ¼å¼çš„æ•´æ•°å€¼ï¼Œå…¶ä¸­ n 为正整数。 + +例如:å‡è®¾éœ€è¦ç”Ÿæˆ 2.4 秒的视频,帧数=2.4×24=57.6。由于 frames 䏿”¯æŒ 57.6,此时您åªèƒ½é€‰æ‹©ä¸€ä¸ªæœ€æŽ¥è¿‘çš„å€¼ã€‚æ ¹æ® 25+4n 计算出最接近的帧数为 57,实际生æˆçš„视频为 57/24=2.375 秒。 + +--- + + +**seed** `integer` `默认值 -1` +ç§å­æ•´æ•°ï¼Œç”¨äºŽæŽ§åˆ¶ç”Ÿæˆå†…å®¹çš„éšæœºæ€§ã€‚ +å–值范围:[\-1, 2^32\-1]之间的整数。 +:::warning + +* 相åŒçš„请求下,模型收到ä¸åŒçš„seedå€¼ï¼Œå¦‚ï¼šä¸æŒ‡å®šseed值或令seedå–值为\-1ï¼ˆä¼šä½¿ç”¨éšæœºæ•°æ›¿ä»£ï¼‰ã€æˆ–æ‰‹åŠ¨å˜æ›´seed值,将生æˆä¸åŒçš„结果。 +* 相åŒçš„请求下,模型收到相åŒçš„seed值,会生æˆç±»ä¼¼çš„结果,但ä¸ä¿è¯å®Œå…¨ä¸€è‡´ã€‚ + + +::: +--- + + +**camera_fixed** `boolean` `默认值 false` +> å‚è€ƒå›¾åœºæ™¯ä¸æ”¯æŒ + +是å¦å›ºå®šæ‘„åƒå¤´ã€‚枚举值: + +* true:固定摄åƒå¤´ã€‚å¹³å°ä¼šåœ¨ç”¨æˆ·æç¤ºè¯ä¸­è¿½åŠ å›ºå®šæ‘„åƒå¤´ï¼Œå®žé™…效果ä¸ä¿è¯ã€‚ +* false:ä¸å›ºå®šæ‘„åƒå¤´ã€‚ + + +--- + + +**watermark** `boolean` `默认值 false` +生æˆè§†é¢‘是å¦åŒ…嫿°´å°ã€‚枚举值: + +* false:ä¸å«æ°´å°ã€‚ +* trueï¼šå«æœ‰æ°´å°ã€‚ + + +--- + + + +## å“åº”å‚æ•° +> 跳转 [è¯·æ±‚å‚æ•°](#RxN8G2nH) + +**id ** `string` +视频生æˆä»»åŠ¡ ID 。仅ä¿å­˜ 7 天(从 **created at** 时间戳开始计算),超时åŽå°†è‡ªåŠ¨æ¸…é™¤ã€‚ + +* 设置`"draft": true`,为 Draft 视频任务 ID。 +* 设置 `"draft": false`,为正常视频任务 ID。 + +创建视频生æˆä»»åŠ¡ä¸ºå¼‚æ­¥æŽ¥å£ï¼ŒèŽ·å– ID åŽï¼Œéœ€è¦é€šè¿‡ [查询视频生æˆä»»åŠ¡ API](https://www.volcengine.com/docs/82379/1521309) æ¥æŸ¥è¯¢è§†é¢‘生æˆä»»åŠ¡çš„çŠ¶æ€ã€‚任务æˆåŠŸåŽï¼Œä¼šè¾“出生æˆè§†é¢‘çš„`video_url`。 + + diff --git a/docs/API文档/推ç†èŠ‚ç‚¹.md b/docs/API文档/推ç†èŠ‚ç‚¹.md new file mode 100644 index 0000000..194284a --- /dev/null +++ b/docs/API文档/推ç†èŠ‚ç‚¹.md @@ -0,0 +1,1074 @@ +数分钟内完æˆä½ çš„首次 API 调用。 + + + + + + + +**快速入门(新手版)** +专为零基础用户设计的快速入门 + + + + + + + + + + + + +**体验中心** +“0â€ä»£ç ï¼Œäº¤äº’å¼ä½“验模型能力 + + + + + + + + + + + + +**Coding Plan** +å…¼å®¹ä¸»æµ AI ç¼–ç å·¥å…·ï¼ŒåŠ©åŠ›é«˜æ•ˆç¼–ç å¼€å‘ + + + + + + + + + + +# 1 获å–å¹¶é…ç½® API Key + +1. èŽ·å– API Key:访问[API Key 管ç†](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey) ,创建你的 API Key。 +2. é…置环境å˜é‡ï¼šåœ¨ç»ˆç«¯ä¸­è¿è¡Œä¸‹é¢å‘½ä»¤ï¼ˆæ›¿æ¢`your_api_key_here` 为你的方舟API Key),é…ç½® API Key 到环境å˜é‡ã€‚ +> é…ç½®æŒä¹…化环境å˜é‡æ–¹æ³•å‚è§ [环境å˜é‡é…置指å—](/docs/82379/1820161)。 + + +```mixin-react +return ( + + + +); +``` + + + +# 2 开通模型æœåŠ¡ +访问 [开通管ç†é¡µé¢](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement) 开通模型æœåŠ¡ã€‚ + +# 3 安装 SDK +安装官方或三方 SDK。 + +```mixin-react +return ( + è¿è¡ŒçŽ¯å¢ƒä¸­éœ€å®‰è£… [Python](https://www.python.org/downloads/) 版本 3.7 或以上。 + +* 安装方舟 SDK: + \`\`\`Bash + pip install 'volcengine-python-sdk[ark]' + \`\`\` + +* 安装 OpenAI SDK: + \`\`\`Bash + pip install openai + \`\`\` + +`}> + 环境中安装 [Go](https://golang.google.cn/doc/install) 版本 1.18 或以上。 + +在代ç ä¸­é€šè¿‡ä¸‹æ–¹æ–¹æ³•引入 Go SDK +\`\`\`Go +import ( + "github.com/volcengine/volcengine-go-sdk" +) +\`\`\` + +`}> + 环境中安装 [Java](https://www.java.com/en/download/help/index_installing.html) 版本 1.8 或以上。 + +在项目的\`pom.xml\`文件中添加以下ä¾èµ–é…置。 +\`\`\`XML + + com.volcengine + volcengine-java-sdk-ark-runtime + LATEST + +\`\`\` + +`}>); +``` + + +# 4 å‘èµ· API 请求 +以下按输入输出类别列举的典型任务,选择任æ„示例代ç ä½“验如何通过 API 调用åŠä½“éªŒå¤§æ¨¡åž‹åŠæ–¹èˆŸå¹³å°èƒ½åŠ›ã€‚ + +## æ–‡æœ¬ç”Ÿæˆ +传入文本类信æ¯ç»™æ¨¡åž‹ï¼Œè¿›è¡Œé—®ç­”ã€åˆ†æžã€æ”¹å†™ã€æ‘˜è¦ã€ç¼–程ã€ç¿»è¯‘等任务,并返回文本结果。 + + +|输入 |输出预览 | +|---|---| +|Hello |* æ€è€ƒï¼šGot it, let's see. The user said "hello". I need to respond in a friendly and welcoming way. Since the system prompt mentions a professional but friendly tone, I should keep it natural. Maybe something like "Hello! How can I assist you today?" That's simple, polite, and open\-ended to encourage the user to share what they need help with.|\ +| |* 回答:Hello! How can I assist you today? Whether you have a question, need help with something specific, or just want to chat, feel free to let me know. 😊 | + + +```mixin-react +return ( + + + + +); +``` + + +* [文本生æˆ](/docs/82379/1399009):文本生æˆä½¿ç”¨æŒ‡å—。 +* [深度æ€è€ƒ](/docs/82379/1956279):深度æ€è€ƒèƒ½åŠ›ä½¿ç”¨æŒ‡å—。 +* [è¿ç§»è‡³ Responses API](/docs/82379/1585128):新用户推è,更简æ´çš„上下文管ç†èƒ½åŠ›ã€å¼ºå¤§çš„工具调用能力。 +* [Chat API](https://www.volcengine.com/docs/82379/1494384):存é‡ä¸šåŠ¡è¿­ä»£æŽ¨è,广泛使用的 API。 + + +## 多模æ€ç†è§£ +传入图片ã€è§†é¢‘ã€PDF文件给模型,进行分æžã€å†…容审核ã€é—®ç­”ã€è§†è§‰å®šä½ç­‰åŸºäºŽå¤šæ¨¡æ€ç†è§£ç›¸å…³ä»»åŠ¡ï¼Œå¹¶è¿”å›žæ–‡æœ¬ç»“æžœã€‚ + + +|输入 |输出预览 | +|---|---| +|![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/a31c2edfbe844461a43f5e8f74fbcce4~tplv-goo7wpa0wc-image.image =275x) |* æ€è€ƒï¼šç”¨æˆ·çŽ°åœ¨éœ€è¦æ‰¾æ”¯æŒè¾“入图片的模型系列,看表格里的输入列中的图åƒåˆ—,哪个模型对应的图åƒè¾“入是√。看表格,Doubao\-1.5\-vision那一行的输入图åƒåˆ—是√,其他两个Doubao\-1.5\-proå’Œlite的输入图åƒéƒ½æ˜¯Ã—,所以答案是Doubao\-1.5\-vision。|\ +|> 支æŒè¾“入图片的模型系列是哪个? |* 回答:支æŒè¾“入图片的模型系列是Doubao\-1.5\-vision | + + +```mixin-react +return ( + + + + +); +``` + + +* [多模æ€ç†è§£](/docs/82379/1958521):多模æ€ç†è§£è¯¦ç»†ä½¿ç”¨æŒ‡å—。 +* [è§†è§‰å®šä½ Grounding](/docs/82379/1616136)ï¼šå›¾ç‰‡ä¸­æ‰¾åˆ°å¯¹åº”ç›®æ ‡å¹¶è¿”å›žåæ ‡ä»»åŠ¡ã€‚ +* [GUI 任务处ç†](/docs/82379/1584296):在计算机/移动设备中完æˆè‡ªåŠ¨åŒ–ä»»åŠ¡ã€‚ +* [文件输入(File API)](/docs/82379/1885708):传入图片ã€è§†é¢‘ã€æ–‡æ¡£æŽ¥å£ã€‚ + + +## å›¾ç‰‡ç”Ÿæˆ +ä¼ å…¥å›¾ç‰‡ã€æ–‡å­—给模型,进行以下场景&任务: + +* å¹¿å‘Šã€æµ·æŠ¥ã€ç»„图等图片生æˆï¼› +* 增改元素ã€é¢œè‰²æ›´æ¢ç­‰å›¾ç‰‡ç¼–辑; +* æ²¹å¢¨ã€æ°´å¢¨ç­‰é£Žæ ¼åˆ‡æ¢ã€‚ + + + +|æç¤ºè¯ |输出预览 | +|---|---| +|充满活力的特写编辑肖åƒï¼Œæ¨¡ç‰¹çœ¼ç¥žçŠ€åˆ©ï¼Œå¤´æˆ´é›•å¡‘æ„Ÿå¸½å­ï¼Œè‰²å½©æ‹¼æŽ¥ä¸°å¯Œï¼Œçœ¼éƒ¨ç„¦ç‚¹é”利,景深较浅,具有Vogueæ‚å¿—å°é¢çš„ç¾Žå­¦é£Žæ ¼ï¼Œé‡‡ç”¨ä¸­ç”»å¹…æ‹æ‘„,工作室ç¯å…‰æ•ˆæžœå¼ºçƒˆã€‚ |![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/00fb66006eb84b16965b620b6e1f2d78~tplv-goo7wpa0wc-image.image =275x) | + + +```mixin-react +return ( + + + + +); +``` + + +* [Seedream 4.0-5.0 教程](/docs/82379/1824121):主æµç”Ÿå›¾æ¨¡åž‹èƒ½åЛ以åŠå¦‚何通过 API 调用。 +* [Seedream 4.0-4.5 æç¤ºè¯æŒ‡å—](/docs/82379/1829186):使用生图模型时,如何编写æç¤ºè¯ã€‚ + + +## è§†é¢‘ç”Ÿæˆ +通过文本æè¿°ã€å›¾åƒç´ æã€è§†é¢‘ç´ æï¼Œå¿«é€Ÿç”Ÿæˆé«˜è´¨é‡ã€é£Žæ ¼å¤šæ ·çš„视频内容。 + + +|æç¤ºè¯ |输出画é¢é¢„览 | +|---|---| +|一ä½èº«ç©¿ç»¿è‰²äº®ç‰‡ç¤¼æœçš„女性站在粉红色背景å‰ï¼Œå‘¨å›´é£˜è½ç€äº”彩斑斓的彩纸 |![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/aae3d0c636954bdd9e66e7a23e98c480~tplv-goo7wpa0wc-image.image =275x) | + + +```mixin-react +return ( + + contents = new ArrayList<>(); + contents.add(Content.builder() + .type("text") + .text("一ä½èº«ç©¿ç»¿è‰²äº®ç‰‡ç¤¼æœçš„女性站在粉红色背景å‰ï¼Œå‘¨å›´é£˜è½ç€äº”彩斑斓的彩纸 --wm true --dur 5") + .build()); + + // Create a video generation task + CreateContentGenerationTaskRequest createRequest = CreateContentGenerationTaskRequest.builder() + .model("doubao-seedance-2-0-260128") // Replace with Model ID + .content(contents) + .build(); + + CreateContentGenerationTaskResult createResult = service.createContentGenerationTask(createRequest); + System.out.println(createResult); + + // Get the details of the task + String taskId = createResult.getId(); + GetContentGenerationTaskRequest getRequest = GetContentGenerationTaskRequest.builder() + .taskId(taskId) + .build(); + + System.out.println("----- polling task status -----"); + while (true) { + try { + GetContentGenerationTaskResponse getResponse = service.getContentGenerationTask(getRequest); + String status = getResponse.getStatus(); + if ("succeeded".equalsIgnoreCase(status)) { + System.out.println("----- task succeeded -----"); + System.out.println(getResponse); + service.shutdownExecutor(); + break; + } else if ("failed".equalsIgnoreCase(status)) { + System.out.println("----- task failed -----"); + System.out.println("Error: " + getResponse.getStatus()); + service.shutdownExecutor(); + break; + } else { + System.out.printf("Current status: %s, Retrying in 3 seconds...\\n", status); + TimeUnit.SECONDS.sleep(3); + } + } catch (InterruptedException ie) { + Thread.currentThread().interrupt(); + System.err.println("Polling interrupted"); + service.shutdownExecutor(); + break; + } + } + } +} +\`\`\` + +`}> +); +``` + + +* [视频生æˆ](/docs/82379/1366799):学习如何使用模型的视频生æˆèƒ½åŠ›ï¼ŒåŒ…æ‹¬æ–‡æœ¬ç”Ÿæˆè§†é¢‘ã€é¦–尾帧生视频ã€é¦–帧生æˆè§†é¢‘等。 +* [Seedance-1.0-pro&pro-fast æç¤ºè¯æŒ‡å—](/docs/82379/1631633):使用生视频模型时,如何编写æç¤ºè¯ã€‚ + + +## 工具使用 +通过工具/æ’件让模型具体读å–外部数æ®åŠå‡½æ•°çš„能力,包括 + +* 内置工具:è”网æœç´¢ã€å›¾ç‰‡å¤„ç†ã€çŸ¥è¯†åº“检索等已集æˆè‡³æ–¹èˆŸå¹³å°çš„工具。 +* 三方工具:兼容MCP 的三方工具。 +* 自定义工具:您自行定义åŠå¼€å‘的工具。 + + + +|输入 |输出预览 | +|---|---| +|What's the weather like in Beijing? |According to the latest weather data as of March 10, 2026, the current weather in Beijing is sunny with a gentle wind (less than level 3). The temperature around 11:30 AM is approximately 9°C, and it is expected to reach a high of 12°C during the day. The weather will remain clear at night with a low temperature of 1°C.|\ +| |**Source**: Weather forecasts updated on March 10, 2026, from the Central Meteorological Observatory.|\ +| |**Note: Data is accurate as of the latest available update at 05:30 AM on March 10.** | + + +```mixin-react +return ( + + + buildTools() { + ToolWebSearch t = ToolWebSearch.builder().build(); + System.out.println(Arrays.asList(t)); + return Arrays.asList(t); + } + + public static void main(String[] args) throws JsonProcessingException { + String apiKey = System.getenv("ARK_API_KEY"); + + ArkService arkService = ArkService.builder().apiKey(apiKey).baseUrl("https://ark.cn-beijing.volces.com/api/v3").build(); + CreateResponsesRequest req = CreateResponsesRequest.builder() + .model("doubao-seed-2-0-lite-260215") + .input(ResponsesInput.builder().addListItem( + ItemEasyMessage.builder().role(ResponsesConstants.MESSAGE_ROLE_USER).content( + MessageContent.builder() + .addListItem(InputContentItemText.builder().text("What's the weather like in Beijing?").build()) + .build() + ).build() + ).build()) + .tools(buildTools()) + .build(); + ResponseObject resp = arkService.createResponse(req); + System.out.println(resp); + + arkService.shutdownExecutor(); + } +} +\`\`\` + +`}> + +); +``` + + +* [工具调用](/docs/82379/1958524):学习如何让模型使用内置工具,如网页æœç´¢ã€çŸ¥è¯†åº“检索ã€è±†åŒ…助手等能力。 +* [函数调用 Function Calling](/docs/82379/1262342):学习如何让模型调用自定义的工具。 +* [云部署 MCP / Remote MCP](/docs/82379/1827534):学习如何让模型使用 MCP æœåŠ¡ã€‚ + + +# 5 下一步 +现在你已ç»å®Œæˆäº†é¦–次方舟模型æœåŠ¡çš„ API 调用,你å¯ä»¥æŽ¢ç´¢æ¨¡åž‹çš„æ›´å¤šèƒ½åŠ›ï¼ŒåŒ…æ‹¬ï¼š + +* [å¹³å°èƒ½åŠ›é€Ÿè§ˆ](/docs/82379/1108216)ï¼šæŽ¢ç´¢æ–¹èˆŸå¹³å°æä¾›çš„æç¤ºè¯ä¼˜åŒ–ã€æƒé™ç®¡ç†ã€æ¨¡åž‹ç®¡ç†ç­‰é«˜é˜¶èƒ½åŠ›ã€‚ +* [模型列表](/docs/82379/1330310):快速æµè§ˆæ–¹èˆŸæä¾›çš„æ¨¡åž‹å…¨é›†ä»¥åŠå„个模型所具备的能力,快速根æ®ä½ çš„实际场景匹é…到åˆé€‚的模型。 + + +