Text to Image API

Ang Text to Image API ay isang tampok na nagbibigay-daan sa iyo na isama ang kakayahan ng Meshy sa pagbuo ng AI na mga imahe sa iyong sariling aplikasyon. Bumuo ng mga de-kalidad na imahe mula sa mga text prompt gamit ang aming makapangyarihang mga AI model.

POST/openapi/v1/text-to-image

Gumawa ng Text to Image na Gawain

Ang endpoint na ito ay nagbibigay-daan sa iyo na lumikha ng bagong Text to Image na gawain. Sumangguni sa The Text to Image Task Object upang makita kung aling mga katangian ang kasama sa Text to Image na gawain na object.

Mga Parameter

Name
ai_model
Type
string
Kinakailangan
Description
ID ng modelong gagamitin para sa pagbuo ng imahe.
Mga magagamit na halaga:
- nano-banana: Karaniwang modelo (3 credits bawat imahe)
- nano-banana-2: Balanced na modelo na may mas malakas na kakayahan kaysa sa karaniwan (6 credits bawat imahe)
- nano-banana-pro: Pro na modelo na may pinahusay na kalidad (9 credits bawat imahe)
- gpt-image-2: OpenAI GPT Image 2, isang high-fidelity na modelo ng imahe (9 credits bawat imahe)
Name
prompt
Type
string
Kinakailangan
Description
Isang paglalarawan ng teksto ng imaheng nais mong likhain. Maging detalyado para sa pinakamahusay na resulta.
Name
generate_multi_view
Type
boolean
default false
Description
Kapag nakatakda sa true, bumubuo ng multi-view na imahe na nagpapakita ng paksa mula sa iba't ibang anggulo.
Kapag ang generate_multi_view ay true, ang aspect_ratio na parameter ay hindi maaaring itakda.
Name
pose_mode
Type
string
Description
Tukuyin ang pose mode para sa pagbuo ng karakter. Kapag hindi tinukoy, ang imahe ay nabubuo nang walang anumang pose presets.
Mga magagamit na halaga: a-pose, t-pose
Name
aspect_ratio
Type
string
default 1:1
Description
Tukuyin ang aspect ratio ng nabubuong imahe. Ang mga pinapayagang halaga ay nakadepende sa napiling 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
Mga magagamit na halaga:
- 1:1: Square na format
- 16:9: Widescreen na landscape
- 9:16: Widescreen na portrait
- 4:3: Karaniwang landscape (hindi sinusuportahan ng gpt-image-2)
- 3:4: Karaniwang portrait (hindi sinusuportahan ng gpt-image-2)
- 3:2: Landscape (tanging sinusuportahan ng gpt-image-2)
- 2:3: Portrait (tanging sinusuportahan ng gpt-image-2)
Name
remove_background
Type
boolean
default false
Description
Kapag nakatakda sa true, ang nabubuong imahe ay ibinabalik bilang transparent na RGBA PNG na may tinanggal na background, kaya maaari mong i-composite ang paksa sa anumang background.

Mga Ibinabalik

Ang result na katangian ng tugon ay naglalaman ng task id ng bagong nilikhang Text to Image na gawain.

Mga Paraan ng Pagkabigo

Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:
- Nawawalang parameter: Isang kinakailangang parameter (hal., ai_model, prompt) ay nawawala.
- Di-wastong parameter: ai_model o aspect_ratio ay hindi isa sa mga pinapayagang halaga.
- Salungatan: Ang generate_multi_view at aspect_ratio ay hindi maaaring gamitin nang sabay.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits upang isagawa ang gawaing ito.
Name
429 - Too Many Requests
Description
Naabot mo na ang iyong rate limit.

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

Kunin ang isang Text to Image Task

Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang Text to Image task gamit ang isang wastong task id. Sumangguni sa The Text to Image Task Object upang makita kung aling mga katangian ang kasama sa Text to Image task object.

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Text to Image task na kukunin.

Mga Ibinabalik

Ang tugon ay naglalaman ng Text to Image task object. Tingnan ang The Text to Image Task Object na seksyon para sa mga detalye.

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

Tanggalin ang isang Text to Image na Gawain

Ang endpoint na ito ay permanenteng nagtatanggal ng isang Text to Image na gawain, kasama ang lahat ng kaugnay na mga imahe at datos. Ang aksyong ito ay hindi na maibabalik.

Mga Parameter ng Landas

Name
id
Type
path
Description
Ang ID ng Text to Image na gawain na tatanggalin.

Mga Ibinabalik

Nagbabalik ng 200 OK kapag matagumpay.

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

Listahan ng mga Text to Image na Gawain

Ang endpoint na ito ay nagbibigay-daan sa iyo na makuha ang listahan ng mga Text to Image na gawain.

Mga Parameter

Name
page_num
Type
integer
Description
Numero ng pahina para sa pagination. Nagsisimula at default sa 1.
Name
page_size
Type
integer
Description
Limitasyon ng laki ng pahina. Default sa 10 na item. Ang pinakamataas na pinapayagan ay 50 na item.
Name
sort_by
Type
string
Description
Patlang na gagamitin para sa pag-uuri. Mga magagamit na halaga:
- +created_at: Ayusin ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
- -created_at: Ayusin ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.

Ibinabalik

Nagbabalik ng isang listahan na may pagination ng The Text to Image Task Objects.

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

I-stream ang isang Text to Image na Gawain

Ang endpoint na ito ay nag-i-stream ng mga real-time na update para sa isang Text to Image na gawain gamit ang Server-Sent Events (SSE).

Mga Parameter

Name
id
Type
path
Description
Natatanging pagkakakilanlan para sa Text to Image na gawain na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng The Text to Image Task Objects bilang Server-Sent Events.

Para sa mga PENDING o IN_PROGRESS na gawain, ang response stream ay maglalaman lamang ng kinakailangang mga field na progress at 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=***"
  ]
}

Ang Text to Image Task Object

Ang Text to Image Task object ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng imahe mula sa input na text prompt. Ang object ay may mga sumusunod na katangian:

Mga Katangian

Name
id
Type
string
Description
Natatanging pagkakakilanlan para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang mga pagpapalagay tungkol sa format ng id.
Name
type
Type
string
Description
Ang uri ng gawain sa pagbuo ng imahe. Para sa mga Text to Image na gawain, ito ay palaging text-to-image.
Name
ai_model
Type
string
Description
Ang AI model na ginamit para sa gawain na ito. Ang mga posibleng halaga ay nano-banana, nano-banana-2, nano-banana-pro, o gpt-image-2.
Name
prompt
Type
string
Description
Ang text prompt na ginamit upang makabuo ng imahe.
Name
status
Type
string
Description
Katayuan ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Pag-unlad ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging 0. Kapag ang gawain ay nagtagumpay na, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milliseconds.
Ang isang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 na pamantayan. Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop sa lahat ng mga timestamp sa Meshy API.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan nasimulan ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang katangiang ito ay magiging 0.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang katangiang ito ay magiging 0.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain.
Ang halaga ng field na ito ay makabuluhan lamang kung ang katayuan ng gawain ay PENDING.
Name
image_urls
Type
array
Description
Isang array ng mga downloadable na URL sa mga nabuong imahe. Kapag naka-enable ang generate_multi_view, ang array na ito ay naglalaman ng tatlong URL ng imahe na kumakatawan sa iba't ibang anggulo ng pagtingin. Kung hindi, naglalaman ito ng isang URL ng imahe.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng gawain na ito. Kasalukuyan kapag ang katayuan ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na gawain (ang mga credits ay naibabalik kapag may pagkabigo).

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
}