ข้อความเป็นรูปภาพ 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: โมเดลโปรที่มีคุณภาพสูงขึ้น (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
ระบุโหมดท่าทางสำหรับการสร้างตัวละคร เมื่อไม่ได้ระบุ รูปภาพจะถูกสร้างโดยไม่มีการตั้งค่าท่าทางใดๆ
ค่าที่ใช้ได้: 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, 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) ขาดหายไป
- พารามิเตอร์ไม่ถูกต้อง: ai_model หรือ aspect_ratio ไม่ใช่ค่าที่อนุญาต
- ความขัดแย้ง: 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/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
ตัวระบุเฉพาะสำหรับงาน ข้อความเป็นรูปภาพ ที่จะสตรีม

ผลลัพธ์ที่ได้

ส่งคืนสตรีมของ The Text to Image Task Objects เป็น 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 ข้อความ วัตถุนี้มีคุณสมบัติดังต่อไปนี้:

คุณสมบัติ

Name
id
Type
string
Description
ตัวระบุเฉพาะสำหรับงานนี้ ในขณะที่เราใช้ UUID ที่สามารถเรียงลำดับได้สำหรับ 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
ความคืบหน้าของงาน หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น 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 (เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)

ตัวอย่างวัตถุงานข้อความเป็นรูปภาพ

{
  "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
}