API รูปภาพเป็นรูปภาพ

API รูปภาพเป็นรูปภาพเป็นฟีเจอร์ที่ช่วยให้คุณผสานความสามารถในการแก้ไขรูปภาพด้วย AI ของ Meshy เข้ากับแอปพลิเคชันของคุณเอง แปลงและแก้ไขรูปภาพที่มีอยู่โดยใช้รูปภาพอ้างอิงและพรอมต์ข้อความด้วยโมเดล AI อันทรงพลังของเรา

POST/openapi/v1/image-to-image

สร้างงานรูปภาพเป็นรูปภาพ

เอนด์พอยต์นี้ช่วยให้คุณสร้างงานรูปภาพเป็นรูปภาพใหม่ได้ โปรดดู ออบเจ็กต์งานรูปภาพเป็นรูปภาพ เพื่อดูว่า มีคุณสมบัติใดบ้างที่รวมอยู่ในออบเจ็กต์งานรูปภาพเป็นรูปภาพ

พารามิเตอร์

Name
ai_model
Type
string
จำเป็น
Description
ID ของโมเดลที่จะใช้สำหรับการสร้างรูปภาพ
ค่าที่ใช้ได้:
- nano-banana: โมเดลมาตรฐาน (3 เครดิตต่อรูปภาพ)
- nano-banana-2: โมเดลแบบสมดุลที่มีความสามารถแข็งแกร่งกว่ามาตรฐาน (6 เครดิตต่อรูปภาพ)
- nano-banana-pro: โมเดล Pro ที่มีคุณภาพที่ปรับปรุงแล้ว (9 เครดิตต่อรูปภาพ)
- gpt-image-2: OpenAI GPT Image 2 โมเดลแก้ไขรูปภาพความเที่ยงตรงสูง (12 เครดิตต่อรูปภาพ)
Name
prompt
Type
string
จำเป็น
Description
คำอธิบายข้อความของการแปลงหรือการแก้ไขที่คุณต้องการนำไปใช้กับรูปภาพอ้างอิง
Name
reference_image_urls
Type
array
จำเป็น
Description
อาร์เรย์ของรูปภาพอ้างอิง 1 ถึง 5 รูปที่จะใช้สำหรับงานแก้ไขรูปภาพ ขณะนี้เรารองรับรูปแบบ .jpg, .jpeg และ .png
มีสองวิธีในการให้รูปภาพแต่ละรูป:
- URL ที่เข้าถึงได้แบบสาธารณะ: URL ที่เข้าถึงได้จากอินเทอร์เน็ตสาธารณะ
- Data URI: Data URI ของรูปภาพที่เข้ารหัสแบบ base64 ตัวอย่างของ data URI: data:image/jpeg;base64,<your base64-encoded image data>
Name
generate_multi_view
Type
boolean
ค่าเริ่มต้น false
Description
เมื่อตั้งค่าเป็น true จะสร้างรูปภาพมุมมองหลายด้านที่แสดงวัตถุจากหลายมุม

ส่งคืน

คุณสมบัติ result ของการตอบกลับประกอบด้วย id ของงานรูปภาพเป็นรูปภาพที่เพิ่งสร้างขึ้น

โหมดความล้มเหลว

Name
400 - Bad Request
Description
คำขอไม่สามารถยอมรับได้ สาเหตุที่พบบ่อย:
- พารามิเตอร์ขาดหาย: พารามิเตอร์ที่จำเป็น (เช่น ai_model, prompt, reference_image_urls) ขาดหาย
- รูปแบบรูปภาพไม่ถูกต้อง: รูปภาพอ้างอิงหนึ่งรูปหรือมากกว่าไม่ใช่รูปแบบที่รองรับ
- URL เข้าถึงไม่ได้: ไม่สามารถดาวน์โหลด reference_image_urls หนึ่งรายการหรือมากกว่าได้
Name
401 - Unauthorized
Description
การยืนยันตัวตนล้มเหลว โปรดตรวจสอบ API คีย์ของคุณ
Name
402 - Payment Required
Description
เครดิตไม่เพียงพอสำหรับการดำเนินงานนี้
Name
429 - Too Many Requests
Description
คุณได้เกินการจำกัดอัตราของคุณแล้ว

Request

POST

/openapi/v1/image-to-image

# Transform a reference image with a text prompt
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>"
    ]
  }'


 ## Using Data URI example
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "data:image/png;base64,${YOUR_BASE64_ENCODED_IMAGE_DATA}"
    ]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-image/:id

ดึงข้อมูลงานรูปภาพเป็นรูปภาพ

เอนด์พอยต์นี้ช่วยให้คุณดึงข้อมูลงานรูปภาพเป็นรูปภาพได้เมื่อมี id งานที่ถูกต้อง ดูที่ ออบเจ็กต์งานรูปภาพเป็นรูปภาพ เพื่อดูว่า มีพร็อพเพอร์ตีใดบ้างที่รวมอยู่ในออบเจ็กต์งานรูปภาพเป็นรูปภาพ

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุเฉพาะสำหรับงานรูปภาพเป็นรูปภาพที่ต้องการดึงข้อมูล

ส่งคืน

การตอบกลับมีออบเจ็กต์งานรูปภาพเป็นรูปภาพ ตรวจสอบ ส่วน ออบเจ็กต์งานรูปภาพเป็นรูปภาพ สำหรับรายละเอียด

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

DELETE/openapi/v1/image-to-image/:id

ลบงานรูปภาพเป็นรูปภาพ

เอนด์พอยต์นี้จะลบงานรูปภาพเป็นรูปภาพอย่างถาวร รวมถึงรูปภาพและข้อมูลที่เกี่ยวข้องทั้งหมด การดำเนินการนี้ไม่สามารถย้อนกลับได้

พารามิเตอร์พาธ

Name
id
Type
path
Description
ID ของงานรูปภาพเป็นรูปภาพที่จะลบ

การส่งคืน

ส่งคืน 200 OK เมื่อสำเร็จ

Request

DELETE

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/image-to-image

แสดงรายการงานรูปภาพเป็นรูปภาพ

เอนด์พอยต์นี้ช่วยให้คุณดึงรายการงานรูปภาพเป็นรูปภาพได้

พารามิเตอร์

Name
page_num
Type
integer
Description
หมายเลขหน้าสำหรับการแบ่งหน้า เริ่มต้นและมีค่าเริ่มต้นเป็น 1
Name
page_size
Type
integer
Description
ขีดจำกัดขนาดหน้า ค่าเริ่มต้นคือ 10 รายการ จำนวนสูงสุดที่อนุญาตคือ 50 รายการ
Name
sort_by
Type
string
Description
ฟิลด์ที่จะใช้เรียงลำดับ ค่าที่ใช้ได้:
- +created_at: เรียงลำดับตามเวลาที่สร้างจากน้อยไปมาก
- -created_at: เรียงลำดับตามเวลาที่สร้างจากมากไปน้อย

ส่งคืน

ส่งคืนรายการแบบแบ่งหน้าของ ออบเจ็กต์งานรูปภาพเป็นรูปภาพ

Request

GET

/openapi/v1/image-to-image

curl https://api.meshy.ai/openapi/v1/image-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-image",
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1692771650657,
    "started_at": 1692771667037,
    "finished_at": 1692771669037,
    "expires_at": 1692771679037,
    "image_urls": [
      "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
    ]
  }
]

GET/openapi/v1/image-to-image/:id/stream

สตรีมงานรูปภาพเป็นรูปภาพ

เอนด์พอยต์นี้สตรีมการอัปเดตแบบเรียลไทม์สำหรับงานรูปภาพเป็นรูปภาพโดยใช้ Server-Sent Events (SSE)

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุที่ไม่ซ้ำกันสำหรับงานรูปภาพเป็นรูปภาพที่จะสตรีม

ค่าที่ส่งกลับ

ส่งกลับสตรีมของ อ็อบเจ็กต์งานรูปภาพเป็นรูปภาพ ในรูปแบบ Server-Sent Events

สำหรับงาน PENDING หรือ IN_PROGRESS สตรีมการตอบกลับจะรวมเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

ออบเจ็กต์งานรูปภาพเป็นรูปภาพ

ออบเจ็กต์งานรูปภาพเป็นรูปภาพคือหน่วยงานที่ Meshy ติดตามเพื่อสร้างรูปภาพจากอินพุต รูปภาพอ้างอิง และ prompt แบบข้อความ ออบเจ็กต์มีคุณสมบัติดังต่อไปนี้:

คุณสมบัติ

Name
id
Type
string
Description
ตัวระบุเฉพาะสำหรับงาน แม้ว่าเราจะใช้ UUID แบบ k-sortable สำหรับ id ของงานเป็น รายละเอียดการใช้งานจริง คุณไม่ควรตั้งสมมติฐานใด ๆ เกี่ยวกับรูปแบบของ id
Name
type
Type
string
Description
ประเภทของงานสร้างรูปภาพ สำหรับงานรูปภาพเป็นรูปภาพ ค่านี้จะเป็น image-to-image เสมอ
Name
ai_model
Type
string
Description
โมเดล AI ที่ใช้สำหรับงานนี้ ค่าที่เป็นไปได้คือ nano-banana, nano-banana-2, nano-banana-pro หรือ gpt-image-2
Name
prompt
Type
string
Description
prompt ข้อความที่ใช้เพื่อกำหนดทิศทางการแปลงรูปภาพ
Name
status
Type
string
Description
สถานะของงาน ค่าที่เป็นไปได้คือหนึ่งใน PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED
Name
progress
Type
integer
Description
progress ของงาน หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น 0 เมื่องานสำเร็จแล้ว ค่านี้จะกลายเป็น 100
Name
created_at
Type
timestamp
Description
ไทม์สแตมป์ของเวลาที่งานถูกสร้าง ในหน่วยมิลลิวินาที
ไทม์สแตมป์แสดงจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่วันที่ 1 มกราคม 1970 UTC ตามมาตรฐาน RFC 3339 ตัวอย่างเช่น วันศุกร์ที่ 1 กันยายน 2023 เวลา 12:00:00 PM GMT จะแสดงเป็น 1693569600000 ซึ่งใช้กับ ไทม์สแตมป์ ทั้งหมด ใน Meshy API
Name
started_at
Type
timestamp
Description
ไทม์สแตมป์ของเวลาที่งานเริ่มต้น ในหน่วยมิลลิวินาที หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น 0
Name
finished_at
Type
timestamp
Description
ไทม์สแตมป์ของเวลาที่งานเสร็จสิ้น ในหน่วยมิลลิวินาที หากงานยังไม่เสร็จสิ้น คุณสมบัตินี้จะเป็น 0
Name
expires_at
Type
timestamp
Description
ไทม์สแตมป์ของเวลาที่ผลลัพธ์ของงานหมดอายุ ในหน่วยมิลลิวินาที
Name
preceding_tasks
Type
integer
Description
จำนวนของงานก่อนหน้า
ค่าของฟิลด์นี้มีความหมายเฉพาะเมื่อสถานะของงานเป็น PENDING เท่านั้น
Name
image_urls
Type
array
Description
อาร์เรย์ของ URL ที่ดาวน์โหลดได้ไปยังรูปภาพที่สร้างขึ้น เมื่อเปิดใช้งาน generate_multi_view อาร์เรย์นี้จะมี URL รูปภาพสามรายการที่แสดงมุมมองต่างกัน มิฉะนั้น จะมี URL รูปภาพเพียงรายการเดียว
Name
task_error
Type
object
Description
รายละเอียดข้อผิดพลาดสำหรับงานที่ล้มเหลว ดู ข้อผิดพลาด สำหรับข้อมูลอ้างอิงอ็อบเจกต์ task_error แบบเต็ม
Name
consumed_credits
Type
integer
Description
จำนวนเครดิตที่งานนี้ใช้ไป แสดงเมื่อสถานะของงานเป็น PENDING, IN_PROGRESS หรือ SUCCEEDED ส่งคืน 0 สำหรับงาน FAILED (เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)

Example Image to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "preceding_tasks": 0,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3
}