API Teks ke Imej

API Teks ke Imej ialah ciri yang membolehkan anda mengintegrasikan keupayaan penjanaan imej AI Meshy ke dalam aplikasi anda sendiri. Jana imej berkualiti tinggi daripada arahan teks menggunakan model AI kami yang berkuasa.

POST/openapi/v1/text-to-image

Cipta Tugasan Teks ke Imej

Endpoint ini membolehkan anda mencipta tugasan Teks ke Imej baharu. Rujuk Objek Tugasan Teks ke Imej untuk melihat sifat yang disertakan dengan objek tugasan Teks ke Imej.

Parameter

  • Name
    ai_model
    Type
    string
    Diperlukan
    Description

    ID model untuk digunakan bagi penjanaan imej.

    Nilai tersedia:

    • nano-banana: Model standard (3 kredit setiap imej)
    • nano-banana-2: Model seimbang dengan keupayaan yang lebih kuat daripada standard (6 kredit setiap imej)
    • nano-banana-pro: Model Pro dengan kualiti yang dipertingkat (9 kredit setiap imej)
    • gpt-image-2: OpenAI GPT Image 2, model imej fideliti tinggi dengan sokongan nisbah aspek terhad (9 kredit setiap imej)
  • Name
    prompt
    Type
    string
    Diperlukan
    Description

    Penerangan teks tentang imej yang ingin anda jana. Berikan penerangan yang terperinci untuk hasil terbaik.

  • Name
    generate_multi_view
    Type
    boolean
    lalai false
    Description

    Apabila ditetapkan kepada true, menjana imej berbilang pandangan yang menunjukkan subjek dari pelbagai sudut.

    Apabila generate_multi_view ialah true, parameter aspect_ratio tidak boleh ditetapkan.

  • Name
    pose_mode
    Type
    string
    Description

    Tentukan pose_mode untuk penjanaan watak. Apabila ditinggalkan, imej dijana tanpa sebarang pratetap pose.

    Nilai tersedia: a-pose, t-pose

  • Name
    aspect_ratio
    Type
    string
    lalai 1:1
    Description

    Tentukan nisbah aspek imej yang dijana. Nilai yang dibenarkan bergantung pada ai_model yang dipilih:

    • 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 sahaja

    Nilai tersedia:

    • 1:1: Format segi empat sama
    • 16:9: Landskap skrin lebar (tidak disokong oleh gpt-image-2)
    • 9:16: Potret skrin lebar (tidak disokong oleh gpt-image-2)
    • 4:3: Landskap standard (tidak disokong oleh gpt-image-2)
    • 3:4: Potret standard (tidak disokong oleh gpt-image-2)
    • 3:2: Landskap (hanya disokong oleh gpt-image-2)
    • 2:3: Potret (hanya disokong oleh gpt-image-2)

Mengembalikan

Sifat result bagi respons mengandungi id tugasan bagi tugasan Teks ke Imej yang baru dicipta.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

    • Parameter hilang: Parameter yang diperlukan (cth., ai_model, prompt) tiada.
    • Parameter tidak sah: ai_model atau aspect_ratio bukan salah satu nilai yang dibenarkan.
    • Konflik: generate_multi_view dan aspect_ratio tidak boleh digunakan serentak.
  • Name
    401 - Unauthorized
    Description

    Pengesahan gagal. Sila semak kunci API anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melaksanakan tugasan ini.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

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

Dapatkan Tugas Teks ke Imej

endpoint ini membolehkan anda mendapatkan tugas Teks ke Imej dengan id yang sah. Rujuk Objek Tugas Teks ke Imej untuk melihat sifat yang disertakan dengan objek tugas Teks ke Imej.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugas Teks ke Imej yang ingin didapatkan.

Mengembalikan

Respons mengandungi objek tugas Teks ke Imej. Semak bahagian Objek Tugas Teks ke Imej untuk butiran.

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

Padam Tugas Teks ke Imej

Endpoint ini memadamkan tugas Teks ke Imej secara kekal, termasuk semua imej dan data yang berkaitan. Tindakan ini tidak boleh dipulihkan.

Parameter Laluan

  • Name
    id
    Type
    path
    Description

    ID tugas Teks ke Imej yang hendak dipadamkan.

Pulangan

Mengembalikan 200 OK apabila berjaya.

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

Senaraikan Tugasan Teks ke Imej

Endpoint ini membolehkan anda mendapatkan senarai tugasan Teks ke Imej.

Parameter

  • Name
    page_num
    Type
    integer
    Description

    Nombor halaman untuk penomboran halaman. Bermula dan lalai kepada 1.

  • Name
    page_size
    Type
    integer
    Description

    Had saiz halaman. Lalai kepada 10 item. Maksimum yang dibenarkan ialah 50 item.

  • Name
    sort_by
    Type
    string
    Description

    Medan untuk diisih mengikut. Nilai yang tersedia:

    • +created_at: Isih mengikut masa penciptaan dalam tertib menaik.
    • -created_at: Isih mengikut masa penciptaan dalam tertib menurun.

Pulangan

Mengembalikan senarai berhalaman bagi Objek Tugasan Teks ke Imej.

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

Strim Tugasan Teks ke Imej

Endpoint ini menstrim kemas kini masa nyata untuk tugasan Teks ke Imej menggunakan Server-Sent Events (SSE).

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugasan Teks ke Imej yang hendak distrim.

Pulangan

Mengembalikan strim Objek Tugasan Teks ke Imej sebagai Server-Sent Events.

Untuk tugasan PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan medan progress dan status yang diperlukan.

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=***"
  ]
}

Objek Tugasan Teks ke Imej

Objek Tugasan Teks ke Imej ialah unit kerja yang dijejaki oleh Meshy untuk menjana imej daripada input prompt teks. Objek ini mempunyai sifat berikut:

Properties

  • Name
    id
    Type
    string
    Description

    Pengecam unik untuk tugas. Walaupun kami menggunakan UUID boleh diisih-k sebagai butiran pelaksanaan untuk id tugas, anda tidak seharusnya membuat sebarang andaian tentang format id.

  • Name
    type
    Type
    string
    Description

    Jenis tugas penjanaan imej. Untuk tugas Teks ke Imej, ini akan sentiasa menjadi text-to-image.

  • Name
    ai_model
    Type
    string
    Description

    Model AI yang digunakan untuk tugas ini. Nilai yang mungkin ialah nano-banana, nano-banana-2, nano-banana-pro, atau gpt-image-2.

  • Name
    prompt
    Type
    string
    Description

    prompt teks yang digunakan untuk menjana imej.

  • Name
    status
    Type
    string
    Description

    Status tugas. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    progress tugas. Jika tugas belum bermula, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Cap masa apabila tugas dicipta, dalam milisaat.

    Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut piawaian RFC 3339. Contohnya, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai kepada semua cap masa dalam Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum bermula, sifat ini akan menjadi 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai, sifat ini akan menjadi 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Bilangan tugas yang mendahului.

    Nilai medan ini hanya bermakna jika status tugas ialah PENDING.

  • Name
    image_urls
    Type
    array
    Description

    Tatasusunan URL yang boleh dimuat turun kepada imej yang dijana. Apabila generate_multi_view didayakan, tatasusunan ini mengandungi tiga URL imej yang mewakili sudut pandangan berbeza. Jika tidak, ia mengandungi satu URL imej.

  • Name
    task_error
    Type
    object
    Description

    Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dipulangkan semula apabila gagal).

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
}