API ข้อความเป็นรูปภาพ

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

POST/openapi/v1/text-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 โมเดลรูปภาพความเที่ยงตรงสูงที่รองรับอัตราส่วนภาพแบบจำกัด (9 เครดิตต่อรูปภาพ)
Name
prompt
Type
string
จำเป็น
Description
คำอธิบายข้อความของรูปภาพที่คุณต้องการสร้าง ควรอธิบายให้ละเอียดเพื่อผลลัพธ์ที่ดีที่สุด
Name
generate_multi_view
Type
boolean
ค่าเริ่มต้น false
Description
เมื่อตั้งค่าเป็น true จะสร้างรูปภาพมุมมองหลายด้านที่แสดงวัตถุจากหลายมุม
เมื่อ generate_multi_view เป็น true จะไม่สามารถตั้งค่าพารามิเตอร์ aspect_ratio ได้
Name
pose_mode
Type
string
Description
ระบุ mode ท่าทางสำหรับการสร้างตัวละคร เมื่อละไว้ รูปภาพจะถูกสร้างขึ้นโดยไม่มีพรีเซ็ตท่าทางใด ๆ
ค่าที่ใช้ได้: a-pose, t-pose
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, 3:2, 2:3
ค่าที่ใช้ได้:
- 1:1: รูปแบบสี่เหลี่ยมจัตุรัส
- 16:9: แนวนอนแบบจอกว้าง (ไม่รองรับโดย gpt-image-2)
- 9:16: แนวตั้งแบบจอกว้าง (ไม่รองรับโดย gpt-image-2)
- 4:3: แนวนอนมาตรฐาน (ไม่รองรับโดย gpt-image-2)
- 3:4: แนวตั้งมาตรฐาน (ไม่รองรับโดย gpt-image-2)
- 3:2: แนวนอน (รองรับเฉพาะโดย gpt-image-2)
- 2:3: แนวตั้ง (รองรับเฉพาะโดย gpt-image-2)

ส่งคืน

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

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

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

Request

POST

/openapi/v1/text-to-image

# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

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

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

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

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

พารามิเตอร์

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

ส่งคืน

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

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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/text-to-image/:id

ลบงานข้อความเป็นรูปภาพ

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

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

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

ค่าที่ส่งคืน

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

Request

DELETE

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

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/text-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/text-to-image

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "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/text-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/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/text-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": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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 แบบข้อความ ออบเจ็กต์มีคุณสมบัติดังต่อไปนี้:

Properties

Name
id
Type
string
Description
ตัวระบุเฉพาะสำหรับงาน แม้ว่าเราจะใช้ UUID แบบ k-sortable สำหรับ id ของงานเป็น รายละเอียดการใช้งาน คุณไม่ควรตั้งสมมติฐานใดๆ เกี่ยวกับรูปแบบของ id
Name
type
Type
string
Description
ประเภทของงานสร้างรูปภาพ สำหรับงานข้อความเป็นรูปภาพ ค่านี้จะเป็น text-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 ของงาน หากงานยังไม่เริ่มต้น property นี้จะเป็น 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
ไทม์สแตมป์ของเวลาที่งานเริ่มต้น ในหน่วยมิลลิวินาที หากงานยังไม่เริ่มต้น property นี้จะเป็น 0
Name
finished_at
Type
timestamp
Description
ไทม์สแตมป์ของเวลาที่งานเสร็จสิ้น ในหน่วยมิลลิวินาที หากงานยังไม่เสร็จสิ้น property นี้จะเป็น 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 Text to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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
}