Tài liệu API

Mọi model trên nền tảng đều chạy được qua HTTP. Địa chỉ gốc: /api/v1

Xác thực

Tạo token ở trang API & Token và gửi kèm mỗi yêu cầu:

bash

Authorization: Bearer $API_TOKEN

Giữ token ở phía máy chủ. Không nhúng token vào ứng dụng chạy trên trình duyệt hay điện thoại của người dùng.

Chạy model

POST /api/v1/models/{model}/predictions

bash

curl -s -X POST "/api/v1/models/vectorizer-v2/predictions" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Prefer: wait" \
  -d '{"input": {"image": "https://example.com/logo.png"}}'

Trường	Kiểu	Mô tả
`input`	object	Tham số của model. Xem tab API trên trang từng model.
`version`	string	Tuỳ chọn. Mã phiên bản model; bỏ trống để dùng bản mới nhất.

Header Prefer: wait giữ kết nối cho tới khi lượt chạy xong (tối đa 60 giây, hoặc Prefer: wait=30). Không có header này, phản hồi trả về ngay với status là starting.

Lấy kết quả

GET /api/v1/predictions/{id}

json

{
  "id": "k3m9x2p7q4w8",
  "model": "vectorizer-v2",
  "status": "succeeded",
  "input": { "image": "https://example.com/logo.png" },
  "output": "/files/abc123.svg",
  "error": null,
  "metrics": { "predict_time": 0.4 },
  "cost": 500
}

`status`	Ý nghĩa
`starting`	Đang khởi động model
`processing`	Đang chạy
`succeeded`	Xong, kết quả nằm ở `output`
`failed`	Lỗi, xem `error`. Tiền được hoàn vào ví.
`canceled`	Đã huỷ. Tiền được hoàn vào ví.

Hỏi lại mỗi 1 đến 2 giây cho tới khi status là một trong ba trạng thái cuối.

Huỷ lượt chạy

POST /api/v1/predictions/{id}/cancel

Tải file lên

POST /api/v1/files (multipart, trường file, tối đa 25 MB)

bash

curl -s -X POST "/api/v1/files" \
  -H "Authorization: Bearer $API_TOKEN" \
  -F "file=@./input.png"

Phản hồi có trường url. Dùng giá trị đó cho tham số kiểu file của model. Tham số kiểu file cũng nhận thẳng một đường dẫn https:// công khai.

Các endpoint khác

Endpoint	Mô tả
`GET /api/v1/models`	Danh sách model
`GET /api/v1/models/{model}`	Thông tin và tham số của một model
`GET /api/v1/predictions`	Các lượt chạy gần đây của bạn (`limit`, `offset`)
`GET /api/v1/account`	Số dư ví

Mã lỗi

HTTP	Ý nghĩa
400	Tham số không hợp lệ. Trường `error` nói rõ tham số nào.
401	Thiếu token hoặc token không hợp lệ
402	Số dư ví không đủ
404	Không tìm thấy model hoặc lượt chạy
429	Gửi quá nhanh, hoặc đang có quá 5 lượt chạy cùng lúc

Tính tiền

Mỗi model có giá cố định cho một lần chạy, ghi trên trang model. Tiền được trừ khi lượt chạy bắt đầu và hoàn lại tự động nếu lượt chạy lỗi hoặc bị huỷ.