SnapeditAPI
Đăng nhậpBắt đầu miễn phí
Đăng nhập
API Reference

Bắt đầu nhanh

Thực hiện lệnh gọi API đầu tiên trong chưa đầy một phút, sau đó tìm hiểu sâu về xác thực, lỗi, giới hạn tốc độ và khả năng tương thích SDK.

Bắt đầu nhanh

Lệnh gọi API đầu tiên trong 60 giây
1

Lấy khóa API của bạn

Đăng ký tại snapedit.app/dashboard và tạo một khóa API. Chỉ mất 10 giây.

2

Thực hiện lệnh gọi API đầu tiên

Tất cả endpoint đều dùng input_image cho đầu vào hình ảnh và trả về output_image_url — một mẫu nhất quán duy nhất.

# Option A: api-key header
curl -X POST "https://api.snapedit.app/v1/images/remove-background" \
  -H "api-key: sk-snap-xxxxx" \
  -F "input_image=@photo.jpg"

# Option B: Bearer token (OpenAI-compatible)
curl -X POST "https://api.snapedit.app/v1/images/remove-background" \
  -H "Authorization: Bearer sk-snap-xxxxx" \
  -F "input_image=@photo.jpg"
3

Nhận kết quả của bạn

Mọi endpoint hình ảnh đều trả về định dạng tương thích OpenAI. URL kết quả của bạn nằm ở data[0].url. Không cần giải mã base64.

json
{
  "created": 1745827200,
  "data": [
    { "url": "https://outputs.snapedit.app/outputs/abc123.png" }
  ]
}

Thêm ví dụ

# Edit an image with AI prompt
curl -X POST "https://api.snapedit.app/v1/images/edits" \
  -H "api-key: YOUR_API_KEY" \
  -F "input_image=@photo.jpg" \
  -F "prompt=Transform to anime style" \
  -F "mode=editing"

Đầu vào hình ảnh

Most endpoints accept image files or image URLs through fields such as `input_image`, `model_image`, and `cloth_image`. Mask inputs use `input_mask`.

Cần trợ giúp? Snapedit Support

Xử lý lỗi

Lỗi trả về mã trạng thái khác 2xx với phần thân JSON nhất quán. Kiểm tra error.type và error.code để xử lý lỗi theo cách lập trình.

json
{
  "error": {
    "message": "Invalid API key provided.",
    "type": "authentication_error",
    "code": 401
  }
}

Giới hạn tốc độ

60 yêu cầu/phút trên mỗi khóa API. Kiểm tra header x-ratelimit-remaining-requests để theo dõi mức sử dụng. Khi gặp 429, hãy đợi retry-after giây.

Credit

Mỗi lệnh gọi API tốn credit tùy theo mô hình được sử dụng — 1 credit = $0.001. Chi phí mỗi lệnh gọi được liệt kê trong mô tả của từng endpoint. Xem Bảng giá để biết các gói credit.

Thực hành bảo mật tốt nhất

  • Không bao giờ hard-code khóa trong mã nguồn. Hãy dùng biến môi trường (SNAPAPI_KEY).
  • Xoay vòng khóa mỗi 90 ngày. Tạo khóa mới trước khi thu hồi khóa cũ.
  • Dùng khóa riêng cho môi trường phát triển và môi trường production.
  • Đặt giới hạn hạn mức cho mỗi khóa để tránh phát sinh chi phí ngoài dự kiến.
  • Thu hồi ngay lập tức nếu khóa bị lộ. Vào Dashboard → API Keys.

Tương thích OpenAI SDK

Snapedit có thể thay thế trực tiếp cho OpenAI Python & Node SDK — chỉ cần trỏ base_url tới Snapedit và tái sử dụng mã hiện có của bạn.

python
from openai import OpenAI

client = OpenAI(
    api_key="sk-snap-xxxxx",
    base_url="https://api.snapedit.app/v1",
)

result = client.images.generate(
    model="snapedit/z-image",
    prompt="a cat",
)
print(result.data[0].url)