Tài liệu API

bp-id-photo

Ảnh Thẻ AI — Upload ảnh chân dung, AI tạo ảnh thẻ chuẩn với nền màu, ánh sáng đều, sẵn sàng in

type: imageoutput: imageTheo tham số — dùng POST /v1/generations/estimate để báo giá

Input — tham số đầu vào

POST/v1/generations

Gửi JSON gồm "model": "bp-id-photo" và các tham số dưới đây ở cùng cấp. Tham số không có trong bảng sẽ bị từ chối (400).

Tham sốKiểuGiá trị hỗ trợMô tả
modelrequiredstringbp-id-photoMã model
photo_urlrequiredstring (URL image)
Ảnh chân dung — Khuyến khích ảnh nhìn thẳng, nghiêng nhẹ vẫn được. Tránh ảnh nhìn ngang hoặc che mặt.
sizerequiredenum
3:41:1

Mặc định: 3:4

Kích thước
backgroundrequiredenum
whitebluered

Mặc định: white

Màu nền
extrastring

Tối đa 2.000 ký tự

Yêu cầu thêm
tierrequiredenum
economyfast

Mặc định: economy

Tốc độ xử lý
  • Tham số file (string URL) nhận link công khai http(s) — máy chủ tự tải về — hoặc URL trả về từ API tải file POST /account/ai/uploads.
  • Bỏ trống tham số không bắt buộc thì dùng giá trị mặc định.

Ví dụ request

curl -X POST https://nov.ai.vn/api/v1/generations \
  -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{
  "model": "bp-id-photo",
  "photo_url": "https://example.com/image.jpg",
  "size": "3:4",
  "background": "white",
  "tier": "economy"
}'

Output — kết quả trả về

Tác vụ chạy bất đồng bộ. POST /v1/generations trả ngay đối tượng generation với status queued hoặc processing; hỏi lại GET /v1/generations/{id} mỗi 5–10 giây tới khi status là succeeded, failed hoặc cancelled.

GET/v1/generations/{id}
{
  "id": "3f1c...-uuid",
  "object": "generation",
  "code": "T8KQ2M4X",
  "model": "bp-id-photo",
  "status": "succeeded",       // queued | processing | succeeded | failed | cancelled
  "progress": 100,
  "cost": 2400,                // số tiền đã trừ
  "currency": "VND",
  "refunded": false,
  "output": {
    "type": "image",
    "files": [{ "url": "https://nov.ai.vn/uploads/ai/outputs/....png", "type": "image", "name": "image.png" }],
    "text": null
  },
  "error": null,
  "created_at": "2026-10-30T08:00:00.000Z",
  "completed_at": "2026-10-30T08:01:12.000Z"
}
TrườngÝ nghĩa
output.files[].urlLink file kết quả — nên tải về hệ thống của bạn, file trên máy chủ có thể được dọn sau một thời gian.
output.textNội dung văn bản (chỉ có với model trả văn bản).
costSố tiền VND đã trừ vào số dư; lỗi hoặc huỷ thì tự hoàn lại (refunded = true).
errorLý do lỗi khi status = failed.

Báo giá trước khi chạy

POST/v1/generations/estimate

Cùng body với POST /v1/generations, không chạy và không trừ tiền.

# => { "object": "estimate", "model": "bp-id-photo", "cost": 2400, "currency": "VND" }
Lấy API key
bp-id-photo · Tài liệu API | NOV AI