Referensi endpoint

Semua alamat relatif terhadap https://api.xplor3.space/v1. Kecuali GET /models, setiap endpoint butuh header Authorization: Bearer xpk_....

ModelSalin tautan bagian ini

Daftar modelSalin tautan bagian ini

Katalog semua model yang aktif. Publik, tanpa kunci.

Field bertipe image, video, atau audio menerima daftar id unggahan dari POST /uploads. Field max pada field media menunjukkan berapa berkas yang boleh dikirim.

Isi yang sama, dalam bentuk tabel per model lengkap dengan aturan per tier dan mode, ada di Referensi model.

GenerateSalin tautan bagian ini

Mulai jobSalin tautan bagian ini

Memulai generate dan memotong kredit saat itu juga. Butuh email terverifikasi.

Respons 201:

Status jobSalin tautan bagian ini

Perubahan status secara langsungSalin tautan bagian ini

Server-Sent Events (text/event-stream). Pesan pertama adalah status saat ini; pesan berikutnya dikirim setiap kali status atau progres berubah, dan koneksi ditutup saat job selesai. Setiap pesan memuat jobId, status, progress, failCode, failMessage, assets, dan queuePosition (posisi di antrean selama QUEUED).

Daftar jobSalin tautan bagian ini

Riwayat job akun, terbaru lebih dulu. Dipaginasi dengan limit dan cursor.

Batalkan jobSalin tautan bagian ini

Membatalkan job yang masih QUEUED dan mengembalikan kreditnya. Jawabannya { "id": "...", "status": "CANCELED" }. Job yang sudah dikirim ke model dijawab 400 JOB_ALREADY_SENT dan tetap berjalan sampai selesai; job yang sudah selesai dijawab 400 JOB_NOT_CANCELABLE.

BerkasSalin tautan bagian ini

Unggah berkasSalin tautan bagian ini

Multipart, dengan satu berkas di field file. Jenisnya dikenali dari isi berkas, bukan dari namanya: gambar, video, atau audio. Jawabannya 201 dengan id, name, mimeType, dan kind. Berkas yang diunggah juga muncul di Pustaka studio.

Sama, untuk klien yang tidak bisa mengirim multipart. Body JSON { "fileName": "...", "dataBase64": "..." }, dengan isi base64 sampai sekitar 11 MB.

Tautan unduhanSalin tautan bagian ini

Jawabannya { "items": [{ "id", "url", "expiresAt" }] }. Setiap tautan berlaku 15 menit. Id yang bukan milik akunmu tidak ikut dikembalikan.

Satu tautan untuk satu berkas, dengan ?download=true bila perlu.

AkunSalin tautan bagian ini

SaldoSalin tautan bagian ini

balance dan 20 catatan kredit terakhir di ledger. Setiap catatan memuat delta, reason (misalnya JOB_DEBIT, JOB_REFUND, TOPUP), jobId, dan createdAt.

Seluruh catatan kredit, dipaginasi dengan limit dan cursor.

Pemilik kunciSalin tautan bagian ini

id, email, name, dan emailVerified akun pemilik kunci.

Rahasia webhookSalin tautan bagian ini

Rahasia penanda tangan webhook (secret, diawali whsec_) dan nomor versinya (version). Keduanya hanya menerima sesi login di peramban, bukan kunci API, jadi dipakai lewat halaman Kredensial studio. Request dengan kunci API dijawab 403.

ProyekSalin tautan bagian ini

Daftar proyek akun, dengan id yang bisa dikirim sebagai collectionId.

Membuat proyek baru. Body { "name": "Kampanye Lebaran" }.

Memasukkan job yang sudah selesai ke proyek. Body { "jobIds": ["..."] }.