OMICX Documentation

Tải lên một file (hiện tại chỉ hỗ trợ hình ảnh) để sử dụng khi gửi tin nhắn, cho phép tích hợp đa phương thức hình ảnh và văn bản. Hỗ trợ các định dạng: png, jpg, jpeg, webp, gif. Các file đã upload chỉ được sử dụng cho người dùng cuối hiện tại.

Interface này yêu cầu request gửi theo dạng multipart/form-data.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

File cần tải lên.

userstringRequired

Định danh người dùng, định nghĩa theo nguyên tắc của nhà phát triển, phải là duy nhất trong ứng dụng.

Response

Sau khi tải lên thành công, Server sẽ trả về ID của tệp và thông tin liên quan.

idstringformat: "uuid"

namestring

sizeinteger

Kích thước file (bytes).

extensionstring

Đuôi mở rộng của file.

mime_typestring

created_bystringformat: "uuid"

ID của người dùng cuối.

created_atlong

Errors

400

Bad Request Error

413

Content Too Large Error

415

Unsupported Media Type Error

503

Service Unavailable Error

$	curl -X POST https://api.omicx.one/v1/agent/files/upload \
>	-H "X-Api-Key: omx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
>	-H "Content-Type: multipart/form-data" \
>	-F file=@string \
>	-F user="abc-123"

1	{
2	"id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
3	"name": "example.png",
4	"size": 1024,
5	"extension": "png",
6	"mime_type": "image/png",
7	"created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
8	"created_at": 1577836800
9	}

Tải file lên

Headers

Request

Response

Errors