API cục bộ

pixgamma serve, điểm cuối, tham số của /v1/upscale và định dạng kết quả.

PixGammaCập nhật 23/10/2026
api

PixGamma mở một HTTP API chỉ trên máy (mặc định 127.0.0.1:8765) để nối vào script, web, app hay công cụ khác. Bật trong app (công tắc API cục bộ ở góc dưới bên trái) hoặc chạy:

pixgamma serve --port 8765

Điểm cuối

Điểm cuối Việc
GET /health Trạng thái, phiên bản
GET /v1/models Danh sách model đã cài
POST /v1/analyze Gửi ảnh, nhận thiết lập Auto đề xuất
POST /v1/upscale Gửi ảnh, nhận ảnh đã phóng

Ảnh gửi dạng thân request nhị phân (--data-binary).

curl --data-binary @anh.jpg \
  "http://127.0.0.1:8765/v1/upscale?mode=std&scale=2&format=jpg" -o anh-2x.jpg

Tham số của /v1/upscale

Tham số Giá trị
mode auto, standard, fidelity, art, lowres, recover
scale hoặc width / height Kích thước đầu ra
denoise, sharpen, compression, detail, texture, contrast, dehalo 0–100
face, face_style, face_fidelity Phục hồi khuôn mặt, realistic hoặc creative, mức giữ mặt gốc
creativity, resemblance, prompt Recover
text, color 0 tắt giữ chữ, tắt giữ màu gốc
device gpu, all, ane, cpu
format, quality png, jpg, tiff, heic; chất lượng JPEG/HEIC

Kết quả

  • Mặc định trả ảnh, báo cáo JSON nằm trong header X-PixGamma-Report.
  • Gửi Accept: application/json để nhận JSON gồm báo cáo và ảnh base64.
curl -s -H "Accept: application/json" --data-binary @anh.jpg \
  "http://127.0.0.1:8765/v1/upscale?scale=4" | jq '.report.passes, .report.seconds'

API chỉ nghe trên 127.0.0.1, không có xác thực; muốn mở cho máy khác, đặt sau reverse proxy có xác thực.