跳到内容

API Key 环境变量配置 ​

更新时间

本文档是针对 Wiki 中 TC3 调用脚本的配置。TENCENT_SECRET_ID 与 TENCENT_SECRET_KEY 是 Tencent Cloud 账户密钥,与文本网关的 API_TOKEN 不同。

账户密钥与地域 ​

请在 macOS·Linux 终端中执行。每个 export 单独占一行输入。

bash
export TENCENT_SECRET_ID='<SecretId>'
export TENCENT_SECRET_KEY='<SecretKey>'
export TENCENT_REGION='ap-singapore'

SDK 或 tccli 的环境变量名称可能不同。本脚本读取上述三个名称。API 路径与地域请根据所使用服务的 API Reference 选择。

准备调用脚本 ​

安装 Python 3 后,将 tencent-api.py 保存到工作目录。无需额外的软件包。请将模型页面的请求示例保存为 request.json。

bash
python3 --version
python3 -m json.tool request.json > /dev/null

执行首次请求 ​

以下是 MPS 图片请求示例。视频使用 CreateAigcVideoTask,音乐使用 CreateAigcAudioTask。

bash
python3 tencent-api.py mps CreateAigcImageTask request.json > accepted.json

如果使用 VOD,请使用 VOD 模型页面的 JSON,并将 SubAppId 指定为实际的 Application ID。

bash
python3 tencent-api.py vod CreateAigcImageTask request.json > accepted.json

两条命令分别提交一个新的生成任务。请只执行其中一个路径。签名会根据执行时刻的时间与请求体自动计算。

通过 TaskId 查询结果 ​

使用受理响应中的 Response.TaskId 构造查询 JSON。

bash
python3 - <<'PYTHON'
import json
with open('accepted.json') as f:
    response = json.load(f)['Response']
if 'Error' in response:
    raise SystemExit(response['Error'])
with open('query.json', 'w') as f:
    json.dump({'TaskId': response['TaskId']}, f)
PYTHON
python3 tencent-api.py mps DescribeAigcImageTask query.json

MPS 视频使用 DescribeAigcVideoTask,音乐使用 DescribeAigcAudioTask。VOD 需在 query.json 中添加与生成请求相同的 SubAppId,再通过 vod DescribeTaskDetail 查询。

完成判定与文件保存 ​

路径完成判定结果保存
MPS AIGC为 DONE 时查看结果,为 FAIL 时查看失败原因在临时 URL 过期前下载,或通过 StoreCosParam 保存为 COS
VOD AIGC同时查看 FINISH 与 ErrCode=0Temporary 为临时 URL,Permanent 为 VOD FileId

若仍在处理中,请稍后使用相同的 TaskId 查询。不要因为查询返回较慢就重复发送生成请求,否则可能产生额外的任务。实际结果字段请查看 MPS·VOD 的响应示例。

文本模型鉴权 ​

需单独配置在 VOD Text 中签发的 Token。

bash
export API_TOKEN='<VOD API Token>'
curl https://mmu.vod-qcloud.com/v1/models \
  -H "Authorization: Bearer ${API_TOKEN}"

错误排查 ​

现象需检查项
AuthFailure密钥、CAM 权限、本地时间、API 路径
InvalidParameter各模型·版本的字段、JSON 类型、输入 URL
RequestLimitExceeded降低调用频率,等待后重试
在收到生成响应前 timeout检查是否已受理及相关日志,避免重复生成

基于 VitePress 构建 · 部署于腾讯云 EdgeOne Pages