รูปภาพเป็นรูปภาพ 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: โมเดลโปรที่มีคุณภาพสูงขึ้น (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, จะสร้างภาพมุมมองหลายด้านที่แสดงวัตถุจากหลายมุม
เมื่อ generate_multi_view เป็น true, พารามิเตอร์ aspect_ratio ไม่สามารถตั้งค่าได้
Name
aspect_ratio
Type
string
ค่าเริ่มต้น 1:1
Description
ระบุอัตราส่วนของภาพที่ส่งออก ค่าที่อนุญาตขึ้นอยู่กับ ai_model ที่เลือก:
- nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2: 1:1, 16:9, 9:16, 3:2, 2:3
ค่าที่ใช้ได้:
- 1:1: รูปแบบสี่เหลี่ยมจัตุรัส
- 16:9: ภาพแนวนอนกว้าง
- 9:16: ภาพแนวตั้งกว้าง
- 4:3: ภาพแนวนอนมาตรฐาน (ไม่รองรับโดย gpt-image-2)
- 3:4: ภาพแนวตั้งมาตรฐาน (ไม่รองรับโดย gpt-image-2)
- 3:2: ภาพแนวนอน (รองรับเฉพาะโดย gpt-image-2)
- 2:3: ภาพแนวตั้ง (รองรับเฉพาะโดย gpt-image-2)
Name
remove_background
Type
boolean
ค่าเริ่มต้น false
Description
เมื่อตั้งค่าเป็น true, ภาพที่ส่งออกจะถูกส่งกลับเป็น PNG RGBA ที่มีพื้นหลังโปร่งใส เพื่อให้คุณสามารถประกอบวัตถุลงบนพื้นหลังใดๆ ได้

ผลลัพธ์ที่ส่งกลับ

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

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

Name
400 - Bad Request
Description
คำขอไม่เป็นที่ยอมรับ สาเหตุทั่วไป:
- พารามิเตอร์ที่ขาดหายไป: พารามิเตอร์ที่จำเป็น (เช่น ai_model, prompt, reference_image_urls) ขาดหายไป
- รูปแบบภาพไม่ถูกต้อง: หนึ่งหรือมากกว่าหนึ่งภาพอ้างอิงไม่ใช่รูปแบบที่รองรับ
- URL ที่ไม่สามารถเข้าถึงได้: หนึ่งหรือมากกว่า reference_image_urls ไม่สามารถดาวน์โหลดได้
- พารามิเตอร์ไม่ถูกต้อง: aspect_ratio ไม่ใช่หนึ่งในค่าที่อนุญาตสำหรับ ai_model ที่เลือก
- ความขัดแย้ง: generate_multi_view และ aspect_ratio ไม่สามารถใช้พร้อมกันได้
Name
401 - Unauthorized
Description
การยืนยันตัวตนล้มเหลว กรุณาตรวจสอบ API key ของคุณ
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: จัดเรียงตามเวลาสร้างในลำดับจากมากไปน้อย

การส่งคืน

ส่งคืนรายการที่แบ่งหน้า The Image to Image Task Objects

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 ที่สามารถเรียงลำดับได้สำหรับ 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
ความคืบหน้าของงาน ถ้างานยังไม่เริ่ม คุณสมบัตินี้จะเป็น 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
}