Referensi · Resource

Endpoint resource Photta API id yang dibutuhkan setiap pembuatan

Ringkasan singkat

Endpoint resource mengembalikan id yang dibutuhkan oleh panggilan pembuatan: maneken, pose, latar belakang, alas kaki, atribut pakaian, dan label brand, ditambah saldo akun serta penggunaan Anda. Menampilkan daftar tidak memakan biaya.

  • Endpoint resource: 13 resource endpoint
  • Autentikasi: Bearer key
  • Batasan: 600 requests/min

Setiap angka di halaman ini bersumber dari dokumentasi API Photta · diperiksa

Setiap endpoint resource, beserta panggilan yang membacanya

Setiap bagian menautkan kapabilitas yang menggunakan id tersebut.

GET/api/v1/mannequins

Maneken

Menampilkan daftar model yang tersedia untuk try-on pakaian: maneken sistem Photta, unggahan Anda sendiri, dan yang Anda buat dengan API pembuatan maneken. Lakukan POST ke path yang sama untuk mengunggah maneken kustom, yang tetap bersifat privat untuk akun Anda. ID tersebut dimasukkan ke dalam `mannequin_id` pada panggilan 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

Maneken perhiasan

Mengunggah foto model close-up untuk try-on perhiasan. Pemrosesan perhiasan difokuskan pada garis leher, telinga, pergelangan tangan, atau tangan, sehingga membutuhkan set maneken tersendiri, bukan maneken seluruh badan untuk pakaian.

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 perhiasan
GET/api/v1/poses

Pose

Menampilkan daftar pose yang dapat diminta oleh try-on, dapat difilter berdasarkan kategori dan jenis produk yang cocok. Teruskan id sebagai `pose_id`; jika dikosongkan, API akan memilih pose yang pas dengan pakaian tersebut.

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

Panjang dan fit pakaian

Mengembalikan key panjang dan fit yang diterima oleh try-on pakaian. Kirimkan key tersebut, bukan deskripsi teks bebas, agar kemeja yang sama dirender secara konsisten di seluruh katalog.

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

Latar belakang

Menampilkan daftar latar belakang sistem dan unggahan Anda sendiri untuk try-on pakaian, dengan paginasi kursor. Lakukan POST ke path yang sama untuk mengunggah latar belakang kustom; aset ini tetap bersifat privat untuk akun Anda.

curl https://api.photta.app/api/v1/backgrounds \
  -H "Authorization: Bearer $PHOTTA_API_KEY"
API virtual try-on kacamata
POST/api/v1/brand-labels

Label brand

Mengunggah gambar label yang dapat digunakan kembali untuk pekerjaan ghost mannequin dan mengembalikan id yang Anda teruskan sebagai `brand_label_id`, baik pada tugas tunggal maupun batch. GET menampilkan daftar yang telah Anda simpan; DELETE menghapusnya saat Anda mencapai batas akun.

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')
Ghost mannequin API
GET/api/v1/footwear

Alas kaki

Menampilkan daftar opsi alas kaki untuk try-on pakaian, dapat difilter berdasarkan tipe dan gender, dengan paginasi kursor. Gunakan ini untuk memasang sepatu pada model yang sama yang mengenakan pakaian tersebut.

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

Akun

Mengembalikan saldo credit Anda yang dirinci berdasarkan sumber, paket Anda saat ini, dan pembaruan credit berikutnya. Baca data ini sebelum menjalankan batch besar daripada menghadapi kendala kekurangan saldo pada 402.

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

Penggunaan

Jumlah pembuatan dan pengeluaran credit untuk periode penagihan bulan kalender saat ini, dibagi menjadi tugas yang berhasil dan gagal. Endpoint inilah yang sebaiknya dibuatkan grafik, bukan hitungan request Anda sendiri.

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

Pertanyaan seputar endpoint resource

Untuk apa endpoint resource digunakan?

Endpoint ini mengembalikan id yang dibutuhkan oleh panggilan pembuatan — maneken, pose, latar belakang, label brand — ditambah status akun Anda. Tidak ada endpoint di grup ini yang menghasilkan gambar.

Apakah panggilan resource memakan credit?

Tidak. Menampilkan daftar gratis, dan unggahan dalam grup ini — maneken kustom, latar belakang, label brand — juga gratis. Anda hanya membayar untuk proses pembuatan.

Bagaimana cara melakukan paginasi pada daftar yang panjang?

Endpoint daftar menerima limit dan kursor: teruskan id terakhir yang Anda terima sebagai `starting_after` dan baca halaman berikutnya. Simpan data yang Anda peroleh ke dalam cache daripada mengambil ulang daftar pada setiap request.

Bisakah saya mengunggah maneken dan latar belakang saya sendiri?

Bisa. POST `/api/v1/mannequins`, POST `/api/v1/mannequins/jewelry`, POST `/api/v1/backgrounds`, dan POST `/api/v1/brand-labels` semuanya menerima gambar Anda sendiri, dan semua yang Anda unggah bersifat privat untuk akun Anda.

Tempat id ini digunakan

Setiap angka di halaman ini bersumber dari dokumentasi API Photta · diperiksa

Coba API dalam lima menit

Buat Photta API key, tempel cuplikan cURL di atas, dan Anda akan mendapatkan gambar on-model pertama sebelum kopi selesai diseduh.

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