### Response Example Source: https://www.volcengine.com/docs/85621/1777001 Example of a successful response when querying an AIGCMeta task. ```APIDOC ## Response Example ```json { "code": 10000, "data": { "aigc_meta_tagged": true, "status": "done", "video_url": "https://xxxx" }, "message": "Success", "status": 10000, "request_id": "20250805144938F6E5264E9D24EB0C4E0A", "time_elapsed": "57.354545ms" } ``` ``` -------------------------------- ### Request Example Source: https://www.volcengine.com/docs/85621/1777001 Example of a request to submit an AIGCMeta task. ```APIDOC ## Request Example ```json { "req_key": "jimeng_ti2v_v30_pro", "task_id": "7491596536074305586", "req_json": "{\"aigc_meta\": {\"content_producer\": \"001191440300192203821610000\", \"producer_id\": \"producer_id_test123\", \"content_propagator\": \"001191440300192203821610000\", \"propagate_id\": \"propagate_id_test123\"}}" } ``` ``` -------------------------------- ### 即梦AI Request and Response Examples Source: https://www.volcengine.com/docs/85621/1976207?lang=zh This section provides examples of the request JSON payload and the expected JSON responses for both successful operations and error scenarios. ```APIDOC ## Request Example ### Request Body ```json { "return_url": true, "logo_info": { "add_logo": false, "position": 0, "language": 0, "opacity": 1, "logo_text_content": "这里是明水印内容" }, "aigc_meta": { "content_producer": "xxx", "producer_id": "xxx", "logo_text_content": "xxx" } } ``` ## Success Response Example ### Response Body ```json { "code": 10000, "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx" ], "status": "done" }, "message": "Success", "status": 10000, "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" } ``` ## Error Response Example ### Response Body ```json { "code": 50413, "data": null, "message": "Post Text Risk Not Pass", "request_id": "202511281418218670D408837A9B0EB58F", "status": 50413, "time_elapsed": "36.799829ms" } ``` ``` -------------------------------- ### 即梦AI Callback Successful Response Example Source: https://www.volcengine.com/docs/85621/2275082 This is an example of a successful response received via callback from the 即梦AI service. It includes the task ID, status, and image URLs. ```json { "code": 10000, "task_id": "1016263xxxxx45545367", "message": "Success", "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx", // ... ], "status": "done" }, "request_id": "202601221406585EE1349D09B", "time_elapsed": "131.518771ms", "status": 10000 } ``` -------------------------------- ### Successful Response Example Source: https://www.volcengine.com/docs/85621/1616429 This is an example of a successful response from the 即梦AI API. ```APIDOC ## Successful Response Example ### Description This is an example of a successful response from the 即梦AI API. ### Response #### Success Response (200) - **binary_data_base64** (string) - null - **image_urls** (array) - List of image URLs. - (string) - URL of an image. - **status** (string) - Task status (e.g., "done"). - **message** (string) - Success message. - **status** (integer) - Status code (10000 indicates success, ignore). - **request_id** (string) - Unique identifier for the request, useful for debugging. - **time_elapsed** (string) - Time taken for the request to complete. ### Response Example ```json { "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx", // ... ], "status": "done" //任务状态 }, "message": "Success", "status": 10000, //无需关注，请忽略 "request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息 "time_elapsed": "508.312154ms" //链路耗时 } ``` ``` -------------------------------- ### Success Response Example Source: https://www.volcengine.com/docs/85621/2359610 This example shows the structure of a successful response from the 即梦AI API. ```APIDOC ## Success Response Example ### Description This is an example of a successful response from the 即梦AI API. ### Response #### Success Response (200) - **code** (integer) - Status code, should be 10000 for success. - **data** (object) - Contains the result of the operation. - **aigc_meta_tagged** (boolean) - Indicates if AIGC metadata is tagged. - **status** (string) - The status of the task (e.g., "done"). - **video_url** (string) - The URL of the generated video. - **resp_data** (string) - Additional data in JSON string format. - **message** (string) - A message indicating the result of the operation (e.g., "Success"). - **status** (integer) - A status code, generally to be ignored in favor of `code`. - **request_id** (string) - A unique identifier for the request, useful for debugging. - **time_elapsed** (string) - The time taken for the request to complete. ### Response Example ```json { "code": 10000, "data": { "aigc_meta_tagged": true, "status": "done", "video_url": "https://xxxx", "resp_data": "{\"Duration\":17.233333587646484,\"InputVideoDurationSum\":5}" }, "message": "Success", "status": 10000, "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" } ``` ``` -------------------------------- ### Query Task Request and Response Source: https://www.volcengine.com/docs/85621/1747301?lang=zh This section provides an example of a request to query a task and its corresponding successful response, including task status and image URLs. ```APIDOC ## Query Task ### Description Allows users to query the status and results of a previously submitted AI task. ### Method POST ### Endpoint /query_task ### Request Body - **req_key** (string) - Required - The key for the AI service, e.g., "jimeng_i2i_v30". - **task_id** (string) - Required - The ID of the task to query, obtained from the task submission response. - **req_json** (string) - Required - A JSON string containing additional parameters for the task, such as logo information and return URL preferences. ### Request Example ```json { "req_key": "jimeng_i2i_v30", "task_id": "", "req_json": "{\"logo_info\":{\"add_logo\":false,\"position\":0,\"language\":0,\"opacity\":1,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true,\"aigc_meta\":{\"content_producer\":\"xxx\",\"producer_id\":\"xxx\",\"logo_text_content\":\"xxx\",\"logo_text_content\":\"xxx\"}}" } ``` ### Response #### Success Response (200) - **code** (integer) - Status code, 10000 indicates success. - **data** (object) - Contains the task results. - **binary_data_base64** (array of string) - Base64 encoded image data (if requested and available). - **image_urls** (array of string) - URLs of the generated images in JPEG format. - **status** (string) - The current status of the task (e.g., 'done', 'in_queue', 'generating'). - **message** (string) - Success message. - **request_id** (string) - Unique identifier for the request, useful for debugging. - **time_elapsed** (string) - Time taken for the request processing. #### Response Example ```json { "code": 10000, "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx" ], "status": "done" }, "message": "Success", "status": 10000, "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" } ``` #### Error Response Example ```json { "code": 50413, "data": null, "message": "Post Text Risk Not Pass", "request_id": "202511281418218670D408837A9B0EB58F", "status": 50413, "time_elapsed": "36.799829ms" } ``` ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-图生视频-运镜-接口文档 Source: https://www.volcengine.com/docs/85621/1792710?lang=zh 输入首帧图片和文本提示词，调节运镜类型和幅度参数，生成运镜视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-图生视频-运镜-接口文档 ### Description 输入首帧图片和文本提示词，调节运镜类型和幅度参数，生成运镜视频。 ### Method POST ### Endpoint /video/generation/image-to-video-camera-movement ### Parameters #### Request Body - **image** (string) - Required - 首帧图片（Base64编码） - **prompt** (string) - Required - 视频生成提示词 - **camera_movement_type** (string) - Required - 运镜类型 (e.g., pan, tilt, zoom) - **camera_movement_magnitude** (number) - Required - 运镜幅度 - **resolution** (string) - Optional - 视频分辨率, 默认720p ### Request Example ```json { "image": "base64_encoded_image_string", "prompt": "猫咪的全身镜头", "camera_movement_type": "zoom", "camera_movement_magnitude": 1.5, "resolution": "720p" } ``` ### Response #### Success Response (200) - **video_url** (string) - 生成视频的URL #### Response Example ```json { "video_url": "http://example.com/videos/generated_video_with_camera_movement.mp4" } ``` ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-图生视频-运镜-接口文档 Source: https://www.volcengine.com/docs/85621/1792710 输入首帧图片和文本提示词，调节运镜类型和幅度参数，生成运镜视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-图生视频-运镜-接口文档 ### Description 输入首帧图片和文本提示词，调节运镜类型和幅度参数，生成运镜视频。 ### Method POST ### Endpoint /video/generation/image-to-video-camera-motion ### Parameters #### Request Body - **first_frame_image** (string) - Required - Base64 encoded string of the first frame image. - **prompt** (string) - Required - The text prompt for video generation. - **camera_motion_type** (string) - Optional - The type of camera motion (e.g., "pan", "zoom"). - **camera_motion_magnitude** (number) - Optional - The magnitude of the camera motion. - **resolution** (string) - Optional - The desired resolution, e.g., "720P". ### Request Example ```json { "first_frame_image": "data:image/jpeg;base64,iVBORw0KGgo...", "prompt": "A landscape with mountains.", "camera_motion_type": "zoom", "camera_motion_magnitude": 1.5, "resolution": "720P" } ``` ### Response #### Success Response (200) - **video_url** (string) - The URL of the generated video. #### Response Example ```json { "video_url": "https://example.com/videos/generated_video_with_camera_motion.mp4" } ``` ``` -------------------------------- ### 提交任务 Source: https://www.volcengine.com/docs/85621/2283654 Submit a task to the 小云雀-营销成片Agent API to generate marketing videos. This endpoint requires product information and image URLs. ```APIDOC ## POST /visual.volcengineapi.com ### Description Submits a task to generate marketing videos based on provided product and model images. ### Method POST ### Endpoint https://visual.volcengineapi.com ### Parameters #### Query Parameters - **Action** (string) - Required - Interface name, value: CVSync2AsyncSubmitTask - **Version** (string) - Required - Version number, value: 2022-08-31 #### Header Parameters - **Region** (string) - Fixed value: cn-north-1 - **Service** (string) - Fixed value: cv #### Request Body - **req_key** (string) - Required - Service identifier, fixed value: pippit_iv2v_cvtob_master - **product_name** (string) - Required - Product name - **product_img_url_list** (array of string) - Required - List of product main image URLs (only 1 supported, jpg/png, < 2048*2048 resolution) - **model_img_url_list** (array of string) - Optional - List of model image URLs (only 1 supported, jpg/png, < 2048*2048 resolution) ### Request Example ```json { "req_key": "pippit_iv2v_cvtob_master", "product_name": "商品名称", "product_img_url_list": [ "https://xxxx" ], "model_img_url_list": [ "https://xxxx" ] } ``` ### Response #### Success Response (200) - **code** (integer) - Status code, 10000 indicates success. - **data** (object) - Contains task details. - **task_id** (string) - Task ID for querying results. - **message** (string) - Success message. - **request_id** (string) - Unique ID for request tracing. - **time_elapsed** (string) - Time elapsed for the request. #### Response Example ```json { "code": 10000, "data": { "task_id": "7392616336519610409" }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", "time_elapsed": "104.852309ms" } ``` ``` -------------------------------- ### Error Response Example Source: https://www.volcengine.com/docs/85621/1616429 This is an example of an error response from the 即梦AI API. ```APIDOC ## Error Response Example ### Description This is an example of an error response from the 即梦AI API. ### Response #### Error Response - **code** (integer) - Error code. Prioritize checking `code` and then `data.status` to avoid parsing panics. - **data** (null) - This field is null when `code` is not 10000. - **message** (string) - Error message describing the issue. - **request_id** (string) - Unique identifier for the request, useful for debugging. - **status** (integer) - Status code (ignore, same as `code`). - **time_elapsed** (string) - Time taken for the request to complete. ### Response Example ```json { "code": 50413, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": null, //code!=10000的情况下，该字段返回为null "message": "Post Text Risk Not Pass", //错误信息 "request_id": "202511281418218670D408837A9B0EB58F", //排查错误的关键信息 "status": 50413, //无需关注，请忽略 "time_elapsed": "36.799829ms" //链路耗时 } ``` ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-图生视频-首帧-接口文档 Source: https://www.volcengine.com/docs/85621/1792710?lang=zh 输入首帧图片和文本提示词，生成视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-图生视频-首帧-接口文档 ### Description 输入首帧图片和文本提示词，生成视频。 ### Method POST ### Endpoint /video/generation/image-to-video-first-frame ### Parameters #### Request Body - **image** (string) - Required - 首帧图片（Base64编码） - **prompt** (string) - Required - 视频生成提示词 - **resolution** (string) - Optional - 视频分辨率, 默认720p ### Request Example ```json { "image": "base64_encoded_image_string", "prompt": "猫咪的特写镜头", "resolution": "720p" } ``` ### Response #### Success Response (200) - **video_url** (string) - 生成视频的URL #### Response Example ```json { "video_url": "http://example.com/videos/generated_video_from_image.mp4" } ``` ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-图生视频-首帧-接口文档 Source: https://www.volcengine.com/docs/85621/1792710 输入首帧图片和文本提示词，生成视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-图生视频-首帧-接口文档 ### Description 输入首帧图片和文本提示词，生成视频。 ### Method POST ### Endpoint /video/generation/image-to-video-first-frame ### Parameters #### Request Body - **first_frame_image** (string) - Required - Base64 encoded string of the first frame image. - **prompt** (string) - Required - The text prompt for video generation. - **resolution** (string) - Optional - The desired resolution, e.g., "720P". ### Request Example ```json { "first_frame_image": "data:image/jpeg;base64,iVBORw0KGgo...", "prompt": "A person walking in a park.", "resolution": "720P" } ``` ### Response #### Success Response (200) - **video_url** (string) - The URL of the generated video. #### Response Example ```json { "video_url": "https://example.com/videos/generated_video_from_image.mp4" } ``` ``` -------------------------------- ### 即梦AI Error Response Example Source: https://www.volcengine.com/docs/85621/2359611 Example of an error response from the 即梦AI API. ```APIDOC ## Error Response Example ### Description This is an example of an error response from the 即梦AI API, typically returned when a request fails. ### Response #### Error Response - **code** (integer) - The status code indicating the type of error. Priority is given to `code=10000`, then `data.status`, otherwise parsing might panic. - **data** (null) - This field is null when `code` is not 10000. - **message** (string) - A message describing the error. - **request_id** (string) - A unique identifier for the request, crucial for debugging. - **status** (integer) - An internal status code, which can be ignored. - **time_elapsed** (string) - The time taken for the API request to complete, in milliseconds. ### Response Example ```json { "code": 50413, "data": null, "message": "Post Text Risk Not Pass", "request_id": "202511281418218670D408837A9B0EB58F", "status": 50413, "time_elapsed": "36.799829ms" } ``` ``` -------------------------------- ### 即梦AI Success Response Example Source: https://www.volcengine.com/docs/85621/2359611 Example of a successful response from the 即梦AI API. ```APIDOC ## Success Response Example ### Description This is an example of a successful response from the 即梦AI API. ### Response #### Success Response (200) - **data** (object) - The response data, which can vary based on the specific API call. - **time_elapsed** (string) - The time taken for the API request to complete, in milliseconds. ### Response Example ```json { "data": {}, "time_elapsed": "508.312154ms" } ``` ``` -------------------------------- ### Error Response Example Source: https://www.volcengine.com/docs/85621/1777001 Example of an error response when an AIGCMeta task fails. ```APIDOC ## Error Response Example ```json { "code": 50413, "data": null, "message": "Post Text Risk Not Pass", "request_id": "202511281418218670D408837A9B0EB58F", "status": 50413, "time_elapsed": "36.799829ms" } ``` ``` -------------------------------- ### 提交任务 Source: https://www.volcengine.com/docs/85621/2283633?lang=zh Submit a task to generate a video based on provided prompts and media. ```APIDOC ## POST /visual.volcengineapi.com ### Description Submits a task to generate a video using AI based on text prompts and optional reference images or videos. ### Method POST ### Endpoint https://visual.volcengineapi.com ### Parameters #### Query Parameters - **Action** (string) - Required - Interface name, value: CVSync2AsyncSubmitTask - **Version** (string) - Required - Version number, value: 2022-08-31 #### Header Parameters - **Region** (string) - Fixed value: cn-north-1 - **Service** (string) - Fixed value: cv #### Request Body - **req_key** (string) - Required - Service identifier, fixed value: pippit_iv2v_cvtob - **prompt** (string) - Required - Prompt for video generation (<= 2000 characters). - **img_url_list** (array of string) - Optional - URLs of reference images (max 50 combined with video URLs). - **video_url_list** (array of string) - Optional - URLs of reference videos (max 50 combined with image URLs). - **ratio** (string) - Optional - Aspect ratio, e.g., "16:9", "9:16", "4:3", "3:4". - **duration** (string) - Optional - Desired video duration, e.g., "～15s", "～30s", "40～60s". - **language** (string) - Optional - Language for generation (e.g., "Chinese", "English", "Japanese"). - **accent** (string) - Optional - Accent for voice generation (e.g., "PuTongHua", "DongBeiHua"). - **enable_watermark** (bool) - Optional - Whether to enable watermark (default: true). ### Request Example ```json { "req_key": "pippit_iv2v_cvtob", "prompt": "输入提示词", "img_url_list": [ "https://xxxx" ], "video_url_list": [ "https://xxxx" ] } ``` ### Response #### Success Response (200) - **code** (integer) - Status code (10000 for success). - **data** (object) - Contains task details. - **task_id** (string) - Task ID for querying results. - **message** (string) - Success message. - **request_id** (string) - Unique ID for error tracing. - **time_elapsed** (string) - Time taken for the request. #### Response Example ```json { "code": 10000, "data": { "task_id": "7392616336519610409" }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", "time_elapsed": "104.852309ms" } ``` ``` -------------------------------- ### Successful Response Example Source: https://www.volcengine.com/docs/85621/2164806 Example of a successful API response, including request ID and time elapsed. ```APIDOC ## Successful Response Example ### Description This is an example of a successful response from the 即梦AI API. ### Response #### Success Response (200) - **request_id** (string) - Unique identifier for the request, useful for debugging. - **time_elapsed** (string) - The time taken for the request to complete in milliseconds. ### Response Example ```json { "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" } ``` ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-图生视频-首尾帧-接口文档 Source: https://www.volcengine.com/docs/85621/1792710?lang=zh 输入首帧图片、尾帧图片和文本提示词，生成视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-图生视频-首尾帧-接口文档 ### Description 输入首帧图片、尾帧图片和文本提示词，生成视频。 ### Method POST ### Endpoint /video/generation/image-to-video-first-last-frame ### Parameters #### Request Body - **first_frame_image** (string) - Required - 首帧图片（Base64编码） - **last_frame_image** (string) - Required - 尾帧图片（Base64编码） - **prompt** (string) - Required - 视频生成提示词 - **resolution** (string) - Optional - 视频分辨率, 默认720p ### Request Example ```json { "first_frame_image": "base64_encoded_first_frame_image_string", "last_frame_image": "base64_encoded_last_frame_image_string", "prompt": "猫咪从草地跳到沙发上", "resolution": "720p" } ``` ### Response #### Success Response (200) - **video_url** (string) - 生成视频的URL #### Response Example ```json { "video_url": "http://example.com/videos/generated_video_from_frames.mp4" } ``` ``` -------------------------------- ### 即梦AI Success Response Example Source: https://www.volcengine.com/docs/85621/1829013 This is an example of a successful response from the 即梦AI service. The 'status' field within 'data' should be checked for success, and 'code' should be 10000. ```json { "video_url": "https://xxxx" }, "message": "Success", "status": 10000, //无需关注，请忽略 "request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息 "time_elapsed": "508.312154ms" //链路耗时 } ``` -------------------------------- ### 提交任务 Source: https://www.volcengine.com/docs/85621/2283654?lang=zh Submits a task to generate marketing video content. Requires product image and optionally a model image. ```APIDOC ## POST /visual.volcengineapi.com ### Description Submits a task to generate marketing video content. Requires product image and optionally a model image. ### Method POST ### Endpoint https://visual.volcengineapi.com ### Parameters #### Query Parameters - **Action** (string) - Required - Interface name, value: CVSync2AsyncSubmitTask - **Version** (string) - Required - Version number, value: 2022-08-31 #### Header Parameters - **Region** (string) - Fixed value: cn-north-1 - **Service** (string) - Fixed value: cv #### Request Body - **req_key** (string) - Required - Service identifier, fixed value: pippit_iv2v_cvtob_master - **product_name** (string) - Required - Product name - **product_img_url_list** (array of string) - Required - Product main image URL (must be publicly accessible). Supports only 1 image, formats: jpg, png. Recommended resolution: < 2048*2048. - **model_img_url_list** (array of string) - Optional - Model image URL (must be publicly accessible). Supports only 1 image, formats: jpg, png. Recommended resolution: < 2048*2048. ### Request Example ```json { "req_key": "pippit_iv2v_cvtob_master", "product_name": "商品名称", "product_img_url_list": [ "https://xxxx" ], "model_img_url_list": [ "https://xxxx" ] } ``` ### Response #### Success Response (200) - **code** (integer) - Status code, 10000 indicates success. - **data** (object) - Contains task details. - **task_id** (string) - Task ID, used for querying results. - **message** (string) - Success message. - **request_id** (string) - Unique ID for tracing errors. - **time_elapsed** (string) - Time elapsed for the request. #### Response Example ```json { "code": 10000, "data": { "task_id": "7392616336519610409" }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", "time_elapsed": "104.852309ms" } ``` ``` -------------------------------- ### 即梦AI Successful Response Example Source: https://www.volcengine.com/docs/85621/2275082 This is an example of a successful response from the 即梦AI service after a task has been processed. It includes a success code, task status, and image URLs if requested. ```json { "code": 10000, "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx", // ... ], "status": "done" }, "message": "Success", "status": 10000, "request_id": "2025061718460554C9B78D23B0BAB45B2A", "time_elapsed": "508.312154ms" } ``` -------------------------------- ### 即梦AI-视频生成3.0 720P-文生视频-接口文档 Source: https://www.volcengine.com/docs/85621/1792710?lang=zh 通过输入文本提示词生成视频。 ```APIDOC ## 即梦AI-视频生成3.0 720P-文生视频-接口文档 ### Description 输入文本提示词，生成视频。 ### Method POST ### Endpoint /video/generation/text-to-video ### Parameters #### Request Body - **prompt** (string) - Required - 视频生成提示词 - **resolution** (string) - Optional - 视频分辨率, 默认720p - **style** (string) - Optional - 视频风格 ### Request Example ```json { "prompt": "一只猫在草地上奔跑", "resolution": "720p", "style": "anime" } ``` ### Response #### Success Response (200) - **video_url** (string) - 生成视频的URL #### Response Example ```json { "video_url": "http://example.com/videos/generated_video.mp4" } ``` ```