Tài liệu tham khảo · Tài nguyên

Các endpoint tài nguyên của Photta API các ID mà mọi lệnh tạo đều cần

Tóm tắt trong một câu

Các endpoint tài nguyên trả về ID mà lệnh gọi tạo ảnh yêu cầu: ma-nơ-canh, tư thế, phông nền, giày dép, thuộc tính trang phục và nhãn thương hiệu, cùng với số dư tài khoản và mức sử dụng của bạn. Việc liệt kê không tốn phí.

  • Endpoint tài nguyên: 13 resource endpoint
  • Xác thực: Bearer key
  • Giới hạn: 600 requests/min

Mọi số liệu trên trang này đều lấy từ tài liệu Photta API · đã kiểm tra

Mọi endpoint tài nguyên, kèm theo lệnh gọi để đọc dữ liệu

Mỗi phần đều liên kết với tính năng sử dụng các ID đó.

GET/api/v1/mannequins

Ma-nơ-canh

Liệt kê các người mẫu khả dụng cho tính năng try-on trang phục: ma-nơ-canh hệ thống của Photta, các mục bạn tự tải lên và những mục bạn đã tạo bằng API tạo ma-nơ-canh. Gửi POST đến cùng đường dẫn để tải lên ma-nơ-canh tùy chỉnh; mục này sẽ được giữ riêng tư cho tài khoản của bạn. ID này được truyền vào `mannequin_id` trong lệnh gọi try-on.

curl https://api.photta.app/api/v1/mannequins \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Virtual try-on API
POST/api/v1/mannequins/jewelry

Ma-nơ-canh trang sức

Tải lên ảnh người mẫu chụp cận cảnh để try-on trang sức. Trang sức được lấy khung hình tập trung vào cổ áo, tai, cổ tay hoặc bàn tay, do đó cần bộ ma-nơ-canh riêng thay vì bộ toàn thân của trang phục.

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/mannequins/jewelry \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "image": "https://cdn.yourstore.com/models/emma-neck.jpg",
  "jewelry_type": "necklace",
  "gender": "female",
  "name": "Emma"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')
API try-on trang sức
GET/api/v1/poses

Tư thế

Liệt kê các tư thế mà một lượt try-on có thể yêu cầu, lọc được theo danh mục và theo loại sản phẩm phù hợp. Truyền ID vào dưới dạng `pose_id`; nếu bỏ qua, API sẽ tự chọn một tư thế phù hợp với trang phục.

curl https://api.photta.app/api/v1/poses \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Virtual try-on API
GET/api/v1/garment-attributes

Độ dài và độ vừa vặn của trang phục

Trả về các khóa độ dài và độ vừa vặn mà tính năng try-on trang phục chấp nhận. Hãy gửi khóa thay vì mô tả văn bản tự do, để cùng một chiếc áo sơ mi luôn render đồng nhất trên toàn bộ catalogue.

curl https://api.photta.app/api/v1/garment-attributes \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Virtual try-on API
GET/api/v1/backgrounds

Phông nền

Liệt kê các phông nền hệ thống và phông nền do bạn tự tải lên để try-on trang phục, có phân trang bằng cursor. Gửi POST đến cùng đường dẫn để tải lên phông nền tùy chỉnh; mục này sẽ được giữ riêng tư cho tài khoản của bạn.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API virtual try-on kính mắt
POST/api/v1/brand-labels

Nhãn thương hiệu

Tải lên hình ảnh nhãn có thể tái sử dụng cho tác vụ ghost mannequin và trả về một ID để bạn truyền vào `brand_label_id`, áp dụng cho cả job đơn lẻ lẫn hàng loạt. GET dùng để liệt kê những gì bạn đã lưu; DELETE dùng để xóa bớt khi bạn chạm giới hạn tài khoản.

RESPONSE=$(curl -s -X POST https://api.photta.app/api/v1/brand-labels \
  -H "Authorization: Bearer $PHOTTA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "file": "@/path/to/pribrand-label.png",
  "name": "Pribrand Collar Label"
}')
ID=$(echo "$RESPONSE" | jq -r '.data.id')
API ghost mannequin
GET/api/v1/footwear

Giày dép

Liệt kê các tùy chọn giày dép cho tính năng try-on trang phục, lọc được theo loại và giới tính, có phân trang bằng cursor. Dùng để mang giày cho chính người mẫu đang mặc trang phục đó.

curl https://api.photta.app/api/v1/footwear \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Virtual try-on API
GET/api/v1/account

Tài khoản

Trả về số dư credit của bạn được phân tích theo từng nguồn, gói hiện tại và kỳ gia hạn credit tiếp theo. Hãy đọc endpoint này trước khi chạy batch lớn thay vì phát hiện thiếu hụt qua lỗi 402.

curl https://api.photta.app/api/v1/account \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Workflows API
GET/api/v1/account/usage

Mức sử dụng

Số lượng tác vụ tạo và mức tiêu hao credit cho chu kỳ thanh toán tháng dương lịch hiện tại, được tách riêng thành các job thành công và thất bại. Đây là endpoint dùng để vẽ biểu đồ, không phải số liệu yêu cầu do bạn tự theo dõi.

curl https://api.photta.app/api/v1/account/usage \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
Batch ghost mannequin API

Câu hỏi thường gặp về các endpoint tài nguyên

Các endpoint tài nguyên dùng để làm gì?

Chúng trả về các ID mà lệnh gọi tạo ảnh yêu cầu — ma-nơ-canh, tư thế, phông nền, nhãn thương hiệu — cùng với trạng thái tài khoản của bạn. Không có tác vụ nào trong nhóm này tạo ra hình ảnh.

Các lệnh gọi tài nguyên có tốn credit không?

Không. Việc liệt kê là miễn phí, và các thao tác tải lên trong nhóm này — ma-nơ-canh tùy chỉnh, phông nền, nhãn thương hiệu — cũng hoàn toàn miễn phí. Bạn chỉ trả phí cho các lượt tạo.

Làm thế nào để phân trang danh sách dài?

Các endpoint danh sách nhận limit và cursor: hãy truyền ID cuối cùng bạn thấy vào `starting_after` và đọc trang tiếp theo. Hãy lưu cache dữ liệu nhận được thay vì gọi lại danh sách ở mỗi request.

Tôi có thể tải lên ma-nơ-canh và phông nền của riêng mình không?

Có. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds` và POST `/api/v1/brand-labels` đều chấp nhận hình ảnh của bạn, và mọi nội dung bạn tải lên đều được giữ riêng tư cho tài khoản của bạn.

Nơi các ID này được sử dụng

Mọi số liệu trên trang này đều lấy từ tài liệu Photta API · đã kiểm tra

Thử nghiệm API trong năm phút

Tạo một Photta API key, dán đoạn mã cURL ở trên, và bạn sẽ nhận được bức ảnh mẫu mặc đồ đầu tiên trước khi pha xong ly cà phê.

  • 13 resource endpoint
  • Bearer key
  • 600 requests/min