# 上传附件

本接口用于上传需智能体分析的文件，上传成功后返回附件 ID。
**注意事项**：调用[发起对话](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/aily-v1/agent-agent_chat/create)中引用附件ID，发送给智能体识别和分析，获取智能体的分析结果和建议。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/aily/v1/agents/:agent_id/attachments
HTTP Method | POST
接口频率限制 | [特殊频控](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 上传文件(aily:agent_attachment:write)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **示例值**："multipart/form-data; boundary=---7MA4YWxkTrZu0gW"

### 路径参数

名称 | 类型 | 描述
---|---|---
agent_id | string | 智能体id，通过智能体后台详情的地址栏中获取<br>**示例值**："agent_4k4ue29hpwrx2"<br>**数据校验规则**：<br>- 长度范围：`0` ～ `65` 字符

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
file | file | 否 | 文件，仅在type=file时需要传入，支持png/jpg/pdf格式，文件最大支持40M，图片最大支持5M<br>**示例值**：文件二进制
type | string | 是 | 附件类型<br>- 当设置为 `image`或者`file` 时，file必传，doc_url不生效<br>- 当设置为 `feishu_doc`或者`bitable` 时，doc_url必传，file不生效<br>- 可选类型，image、file、feishu_doc、bitable<br>**示例值**："image"<br>**数据校验规则**：<br>- 长度范围：`1` ～ `32` 字符
doc_url | string | 否 | 云文档/多维表格url，仅在type=bitable或者feishu_doc时需要传入<br>**示例值**："https://bytedance.larkoffice.com/wiki/PRSdJR8NowW5gxguFGcm9Hpn"<br>**数据校验规则**：<br>- 长度范围：`0` ～ `512` 字符

### 请求体示例

```HTTP
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file";
Content-Type: application/octet-stream

文件二进制
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="type";

image
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="doc_url";

https://bytedance.larkoffice.com/wiki/PRSdJR8NowW5gxguFGcm9Hpn
---7MA4YWxkTrZu0gW
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
agent_attachment_id | string | 附件id

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "agent_attachment_id": "3d058789-6952-4697-bf9c-1add1ebc206e"
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 2700001 | param is invalid | 检查参数是否正确