API Reference

คู่มือฉบับสมบูรณ์สำหรับการใช้ API Qwen Image Edit

การอ้างอิง API

เอกสารนี้ให้รายละเอียดเกี่ยวกับอินเทอร์เฟซการเขียนโปรแกรมแอปพลิเคชัน (API) สำหรับ Qwen Image Edit คุณสามารถใช้ API เหล่านี้เพื่อรวมความสามารถในการแก้ไขและวิเคราะห์รูปภาพเข้ากับแอปพลิเคชันของคุณได้โดยตรง

จุดสิ้นสุด (Endpoints)

API ของ Qwen Image Edit มีจุดสิ้นสุด RESTful ที่ช่วยให้คุณสามารถดำเนินการต่างๆ ได้

Base URL

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

การยืนยันตัวตน (Authentication)

การเรียก API ทั้งหมดต้องมีการยืนยันตัวตนโดยใช้ API Key ของคุณ ส่ง API Key ของคุณในส่วนหัว Authorization เป็น Bearer Token.

Authorization: Bearer YOUR_API_KEY

Core Methods

1. แก้ไขรูปภาพ: /edit

ใช้จุดสิ้นสุดนี้เพื่อแก้ไขรูปภาพตามคำแนะนำที่ให้ไว้

  • URL: /edit

  • Method: POST

  • Headers:

    • 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)"
      }
    }
  • Response (JSON):

    {
      "job_id": "string",
      "status": "pending" | "processing" | "completed" | "failed",
      "edited_image_url": "string (optional, if completed)",
      "error_message": "string (optional, if failed)"
    }

2. วิเคราะห์รูปภาพ: /analyze

ใช้จุดสิ้นสุดนี้เพื่อวิเคราะห์รูปภาพและดึงข้อมูลเชิงลึก

  • URL: /analyze

  • Method: POST

  • Headers:

    • Content-Type: application/json
    • Authorization: Bearer YOUR_API_KEY
  • Body (JSON):

    {
      "image_url": "string",
      "features": ["labels", "text_detection", "face_detection"]
    }
  • Response (JSON):

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

Utility Methods

1. รับสถานะงาน: /job/{job_id}

ใช้จุดสิ้นสุดนี้เพื่อตรวจสอบสถานะของงานที่ส่งไปก่อนหน้านี้

  • URL: /job/{job_id}

  • Method: GET

  • Headers:

    • Authorization: Bearer YOUR_API_KEY
  • Response (JSON):

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

การกำหนดค่าขั้นสูง

คุณสามารถกำหนดค่าพารามิเตอร์เพิ่มเติมเพื่อควบคุมพฤติกรรมของ API ได้ เช่น callback_url สำหรับ Webhooks หรือ model_version สำหรับการเลือกโมเดล AI ที่เฉพาะเจาะจง

การจัดการข้อผิดพลาด (Error Handling)

API จะส่งคืนรหัสสถานะ HTTP มาตรฐานสำหรับข้อผิดพลาด:

  • 400 Bad Request: คำขอไม่ถูกต้อง (เช่น พารามิเตอร์ที่ขาดหายไปหรือผิดพลาด)
  • 401 Unauthorized: ไม่มีการยืนยันตัวตนหรือ API Key ไม่ถูกต้อง
  • 403 Forbidden: API Key ไม่มีสิทธิ์ในการดำเนินการที่ร้องขอ
  • 404 Not Found: ไม่พบจุดสิ้นสุดหรือทรัพยากร
  • 429 Too Many Requests: เกินขีดจำกัดอัตรา
  • 500 Internal Server Error: ข้อผิดพลาดภายในเซิร์ฟเวอร์

ขีดจำกัดและโควต้า (Limits and Quotas)

การใช้งาน API อยู่ภายใต้ขีดจำกัดอัตราและโควต้าการใช้งาน โปรดดูเอกสารประกอบการกำหนดราคาสำหรับรายละเอียดเพิ่มเติม

Webhooks

คุณสามารถกำหนดค่า Webhooks เพื่อรับการแจ้งเตือนแบบอะซิงโครนัสเมื่อสถานะงานเปลี่ยนแปลง

เหตุการณ์ที่รองรับ

  • job.completed: เมื่อการประมวลผลรูปภาพเสร็จสมบูรณ์
  • job.failed: เมื่อการประมวลผลรูปภาพล้มเหลว

Payload ตัวอย่าง (job.completed)

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

SDKs

เรามี SDK สำหรับภาษาโปรแกรมยอดนิยมเพื่อทำให้การรวม API ง่ายขึ้น:

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