Referensi API

Dokumen ini merinci antarmuka pemrograman aplikasi (API) untuk Qwen Image Edit. Anda dapat menggunakan API ini untuk mengintegrasikan kemampuan pengeditan dan analisis gambar langsung ke dalam aplikasi Anda.

Titik Akhir (Endpoints)

API Qwen Image Edit menyediakan titik akhir RESTful yang memungkinkan Anda melakukan berbagai operasi.

URL Dasar

https://api.qwen-image-edit.com/v1

Otentikasi

Semua panggilan API memerlukan otentikasi menggunakan API Key Anda. Kirim API Key Anda di header Authorization sebagai Bearer Token.

Authorization: Bearer YOUR_API_KEY

Metode Inti

1. Edit Gambar: /edit

Gunakan titik akhir ini untuk mengedit gambar berdasarkan instruksi yang diberikan.

• URL: /edit

• Metode: POST

• Header:

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY

• Body (JSON):

  {
    "image_url": "string",
    "prompt": "string",
    "options": {
      "output_format": "png" | "jpeg" | "webp",
      "quality": "integer (1-100)"
    }
  }

• Respons (JSON):

  {
    "job_id": "string",
    "status": "pending" | "processing" | "completed" | "failed",
    "edited_image_url": "string (opsional, jika selesai)",
    "error_message": "string (opsional, jika gagal)"
  }

2. Analisis Gambar: /analyze

Gunakan titik akhir ini untuk menganalisis gambar dan mengekstrak wawasan.

• URL: /analyze

• Metode: POST

• Header:

  • Content-Type: application/json
  • Authorization: Bearer YOUR_API_KEY

• Body (JSON):

  {
    "image_url": "string",
    "features": ["labels", "text_detection", "face_detection"]
  }

• Respons (JSON):

  {
    "job_id": "string",
    "status": "pending" | "processing" | "completed" | "failed",
    "analysis_results": {
      "labels": ["string"],
      "detected_text": ["string"],
      "faces": ["object"]
    },
    "error_message": "string (opsional, jika gagal)"
  }

Metode Utilitas

1. Dapatkan Status Pekerjaan: /job/{job_id}

Gunakan titik akhir ini untuk memeriksa status pekerjaan yang dikirim sebelumnya.

• URL: /job/{job_id}

• Metode: GET

• Header:

  • Authorization: Bearer YOUR_API_KEY

• Respons (JSON):

  {
    "job_id": "string",
    "status": "pending" | "processing" | "completed" | "failed",
    "edited_image_url": "string (opsional)",
    "analysis_results": "object (opsional)",
    "error_message": "string (opsional)"
  }

Konfigurasi Lanjutan

Anda dapat mengonfigurasi parameter tambahan untuk mengontrol perilaku API, seperti callback_url untuk Webhook atau model_version untuk memilih model AI tertentu.

Penanganan Kesalahan

API akan mengembalikan kode status HTTP standar untuk kesalahan:

• 400 Bad Request: Permintaan tidak valid (misalnya, parameter hilang atau salah).
• 401 Unauthorized: Otentikasi tidak ada atau API Key tidak valid.
• 403 Forbidden: API Key tidak memiliki izin untuk operasi yang diminta.
• 404 Not Found: Titik akhir atau sumber daya tidak ditemukan.
• 429 Too Many Requests: Batas laju terlampaui.
• 500 Internal Server Error: Kesalahan server internal.

Batas dan Kuota

Penggunaan API tunduk pada batas laju dan kuota penggunaan. Silakan lihat dokumentasi harga untuk detail lebih lanjut.

Webhook

Anda dapat mengonfigurasi Webhook untuk menerima notifikasi asinkron ketika status pekerjaan berubah.

Acara yang Didukung

• job.completed: Ketika pemrosesan gambar berhasil diselesaikan.
• job.failed: Ketika pemrosesan gambar gagal.

Contoh Payload (job.completed)

{
  "event": "job.completed",
  "job_id": "string",
  "edited_image_url": "string",
  "timestamp": "datetime"
}

SDK

Kami menyediakan SDK untuk bahasa pemrograman populer untuk mempermudah integrasi API:

• JavaScript/TypeScript
• Python
• PHP
• Java
• Go
• Ruby