调用说明

本文提供的接口调用示例均通过 AK 和 SK 初始化实例。

前提条件

调用接口前，请先完成 Python SDK 的安装及初始化操作。

注意事项

若服务内已经存在同名文件，且您开启了重名覆盖上传，则新上传文件在上传路径及文件名重复时将覆盖同名旧文件。若未开启重名覆盖上传，则新文件上传失败。

调用示例

本节为您介绍上传资源的调用示例。
您可以指定服务 ID 和上传文件，来获取上传成功的资源 URI。
该接口内部依次调用了 ApplyImageUpload 和 CommitImageUpload 两个 OpenAPI 来实现完整文件上传能力。

说明

当上传文件超过 20 MB 时，将自动使用分片上传，每个分片固定为 20 MB。

接口调用示例如下所示。

# coding:utf-8
from __future__ import print_function
from volcengine.imagex.v2.imagex_service import ImagexService


if __name__ == '__main__':
    imagex_service = ImagexService()


    # call below method if you dont set ak and sk in $HOME/.volc/config
    imagex_service.set_ak('ak')
    imagex_service.set_sk('sk')


    params = dict()
    params['ServiceId'] = 'imagex service id'
    params['SkipMeta'] = False
    # 指定上传域名，域名格式参考 https://www.volcengine.com/docs/508/1537728
    # params['UploadHost'] = 'upload host'
    params['SkipCommit'] = False

    # AIGCMetaData 仅支持通过 SDK 传入，不支持通过 OpenAPI 传入。
    # params['AIGCMetaData'] = [
    #     {
    #         'Label': '1',  # AIGC 标签。
    #         'ContentProducer': 'PRODUCERIDALPHA27CHARSXYZAB',  # 内容生产者标识。
    #         'ProduceID': 'prod-20260506-0001',  # 内容生产 ID。
    #         'ReservedCode1': 'reserved-code-1',  # 预留字段 1。
    #         'ContentPropagator': 'PROPAGATORALPHA27CHARSXYZAB',  # 内容传播者标识。
    #         'PropagateID': 'prop-20260506-0001',  # 内容传播 ID。
    #         'ReservedCode2': 'reserved-code-2',  # 预留字段 2。
    #     }
    # ]

    file_paths = ['image file path 1']
    resp = imagex_service.upload_image(params, file_paths)
    print(resp)


    img_datas = ['image data 1']
    resp = imagex_service.upload_image_data(params, img_datas)
    print(resp)

最近更新时间：2026.08.10 17:40:54

这个页面对您有帮助吗？

有用

无用

veImageX

调用说明 #

前提条件 #

注意事项 #

调用示例 #

调用说明

前提条件

注意事项

调用示例