1、功能说明
调用此指令可将本地文件上传至扣子平台,上传成功后会返回对应的文件 ID,用于后续操作(如知识库文件上传等)。若上传失败,文件 ID 将为空。
API 接口详细说明见:https://www.coze.cn/open/docs/developer_guides/upload_files
2、配置参数
| 参数名 | 必填 | 说明 |
|---|---|---|
| Token | 是 | 用于身份验证的令牌,确保请求的合法性。 |
| 文件 | 是 | 待上传的本地文件,可通过 “选择文件” 按钮选择路径。 |
| 返回结果 | 是 | 接口返回的完整响应内容,为字典格式,包含上传状态等信息。 |
| 文件 ID | 是 | 上传成功时返回的文件唯一标识;失败时为空。 |
返回结果示例
成功响应
{
"code": 0,
"msg": "success",
"data": {
"file_id": "uf_872dxxxxxxxxx",
"file_name": "示例文档.pdf",
"size": 3145728
}
}
此时文件ID会被赋值为uf_872dxxxxxxxxx。失败响应
上传失败,指令会抛出错误。
3、示例场景
- 在 “Token” 输入框中填入有效的身份令牌。
- 点击 “选择文件” 按钮,选择本地待上传的文件(如
示例文档.pdf)。 - 运行指令,若上传成功,
文件ID会自动获取到返回的唯一标识;若失败,可通过指令抛出的错误信息查看原因。
4、注意事项
- 文件限制:需注意扣子平台对文件大小、格式的限制(具体以 API 文档为准),超出限制会导致上传失败。
- Token 有效性:Token 过期或无效会直接导致上传失败,需确保 Token 处于有效期内。
- 文件 ID 用途:上传成功的文件 ID 可用于后续指令(如创建知识库文件时关联文件),需妥善保存。
- 失败处理:若上传失败,
文件ID为空,需根据指令中的错误信息调整参数后重新尝试。