> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.omicx.one/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.omicx.one/_mcp/server.

# Tải ảnh lên cho trợ lý

POST https://api.omicx.one/agent/files/upload
Content-Type: multipart/form-data

Lưu một ảnh để một lượt chat sau đó có thể đính kèm bằng id.

Cùng scope với `/agent/chat-messages`, cùng quy tắc: chỉ có trên key đã được gán 1 trợ lý, không thể tự chọn. Thiếu scope → `403 INSUFFICIENT_SCOPE`; key mất ràng buộc → `403 ASSISTANT_NOT_BOUND`.

**Upload:** `multipart/form-data` với phần `file` (ảnh) và trường `user`.

**`user` phải khớp với `userId` bạn dùng khi chat.** File được gắn với tenant của bạn và với đúng người dùng cuối đó — một lượt chat gửi với `userId` khác sẽ không đính kèm được file này.

**Điều được kiểm tra:** loại file thật được nhận diện từ magic bytes, nên một file thực thi đổi tên thành `.png` vẫn bị từ chối với `400`, cũng như file vượt quá 5 MB. Loại file bạn khai báo trong phần multipart chỉ mang tính tham khảo.

**Không tính phí riêng.** Việc lưu trữ hiện chưa được đo tính phí; chỉ lượt chat có đính kèm ảnh mới bị tính phí.

**Retry.** Endpoint này KHÔNG idempotent — gửi lại một upload sẽ lưu thêm 1 bản sao và trả về `id` khác. Chỉ gửi lại khi thật sự không nhận được response.

Reference: https://developers.omicx.one/agent/files/upload-agent-file

## Request

### Headers

- `X-Api-Key` (string, required)

### Body (multipart/form-data)

This endpoint expects a multipart form containing a file.

- `file` (file, required) — Ảnh. Tối đa 5 MB. Định dạng cho phép: PNG, JPEG, WebP, GIF — được nhận diện từ magic bytes của file, không dựa vào phần mở rộng hay content type khai báo, nên đổi tên file không qua được kiểm tra này.
- `user` (string, required) — ID CỦA BẠN cho người dùng cuối của bạn. PHẢI khớp với `userId` bạn gửi ở `POST /agent/chat-messages`; file được gắn với id này, một lượt chat gửi với `userId` khác không đính kèm được. Cùng quy tắc như `userId`: một định danh KHÔNG MANG NGHĨA, không dùng email, số điện thoại, hay tên thật — được lưu nguyên văn dưới dạng plain text.

## Response

### 201

Ảnh đã được lưu.

- `id` (string, required) — Handle của file đã lưu. Giữ lại giá trị này — đây là thứ một lượt chat sau đó gửi lên để đính kèm ảnh. Quyền sở hữu được kiểm tra lại mỗi lần dùng, nên chỉ có id không tự cấp quyền gì.
- `name` (string, required) — Tên file gốc bạn đã upload.
- `size` (long, required) — Dung lượng đã lưu (byte).
- `mimeType` (string, required) — Loại nhận diện được từ magic bytes của file — không phải loại bạn khai báo.
- `createdAt` (string, required) — Thời điểm upload, dạng ISO-8601.
- `extension` (string, optional) — Phần mở rộng viết thường không kèm dấu chấm, hoặc `""` nếu tên không có.
- `url` (string, optional, nullable) — Link để bên đối tác đọc lại file, suy ra từ object key đã lưu. Là URL tuyệt đối khi hệ thống có cấu hình base URL đọc file — object key nội bộ không bao giờ bị lộ ra ngoài.

## Errors

### 400 Bad Request Error

Thiếu `file` hoặc `user`, file vượt quá 5 MB, hoặc loại file nằm ngoài danh sách ảnh cho phép (theo dữ liệu bytes thật).

- `error` (ErrorDetail, required)

### 401 Unauthorized Error

Thiếu hoặc sai API key.

- `error` (ErrorDetail, required)

### 403 Forbidden Error

Thiếu scope `assistant:execute`, hoặc key không còn được gán trợ lý.

- `error` (ErrorDetail, required)

### 413 Content Too Large Error

Request body vượt quá 6 MB (giới hạn 5 MB file cộng overhead multipart).

- `error` (ErrorDetail, required)

### 429 Too Many Requests Error

`RATE_LIMIT_EXCEEDED`.

- `error` (ErrorDetail, required)

### 502 Bad Gateway Error

Nơi lưu trữ tạm thời không khả dụng — thử lại.

- `error` (ErrorDetail, required)

### 503 Service Unavailable Error

Quá nhiều request đồng thời — thử lại sau `Retry-After`.

- `error` (ErrorDetail, required)

## Types

### ErrorDetail

- `code` (string, required) — Nhóm lỗi (dạng máy đọc được), ổn định theo từng HTTP status.
- `message` (string, required) — Mô tả cho con người đọc (dùng để debug), không nên dịch trực tiếp.
- `timestamp` (datetime, required)
- `path` (string, required) — Đường dẫn request đầy đủ.
- `subCode` (string, optional, nullable) — Mã cụ thể, ổn định — dùng để phân nhánh xử lý / dịch i18n. Hãy xử lý logic dựa trên `subCode`, không dựa vào chuỗi `message`.
- `details` (list of ErrorDetailDetailsItems, optional, nullable) — Lỗi theo từng field (chỉ có khi `code` là `VALIDATION_ERROR`).

### ErrorDetailDetailsItems

- `field` (string, optional)
- `message` (string, optional)
- `rejectedValue` (any, optional, nullable)

## Examples

**Request**

```json
{
  "file": "<file: string>",
  "user": "string"
}
```

**Response**

```json
{
  "id": "018f8b3c-6d1b-7a2c-8e4f-5b6c7d8e9f0a",
  "name": "invoice.png",
  "size": 284512,
  "mimeType": "image/png",
  "createdAt": "2026-08-21T09:15:04Z",
  "extension": "png",
  "url": "https://cdn.omicx.one/omicx-files/permanent/tenant-123/agent/invoice.png"
}
```

**SDK Code**

```python
import requests

url = "https://api.omicx.one/agent/files/upload"

files = { "file": "open('string', 'rb')" }
payload = { "user": "string" }
headers = {"X-Api-Key": "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.omicx.one/agent/files/upload';
const form = new FormData();
form.append('file', 'string');
form.append('user', 'string');

const options = {method: 'POST', headers: {'X-Api-Key': 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omicx.one/agent/files/upload"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"string\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nstring\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.omicx.one/agent/files/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"string\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nstring\r\n-----011000010111000001101001--\r\n"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.omicx.one/agent/files/upload")
  .header("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"string\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nstring\r\n-----011000010111000001101001--\r\n")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.omicx.one/agent/files/upload', [
  'multipart' => [
    [
        'name' => 'file',
        'filename' => 'string',
        'contents' => null
    ],
    [
        'name' => 'user',
        'contents' => 'string'
    ]
  ]
  'headers' => [
    'X-Api-Key' => 'omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.omicx.one/agent/files/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Api-Key", "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"string\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nstring\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Api-Key": "omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"]
let parameters = [
  [
    "name": "file",
    "fileName": "string"
  ],
  [
    "name": "user",
    "value": "string"
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

let request = NSMutableURLRequest(url: NSURL(string: "https://api.omicx.one/agent/files/upload")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```