टेक्स्ट से इमेज API

टेक्स्ट से इमेज API एक फीचर है जो आपको Meshy की AI इमेज जनरेशन क्षमताओं को अपने खुद के एप्लिकेशन में इंटीग्रेट करने की सुविधा देता है। हमारे शक्तिशाली AI मॉडल का उपयोग करके टेक्स्ट प्रॉम्प्ट से उच्च-गुणवत्ता वाली इमेज जनरेट करें।

POST/openapi/v1/text-to-image

टेक्स्ट से इमेज टास्क बनाएं

यह एंडपॉइंट आपको एक नया टेक्स्ट से इमेज टास्क बनाने की अनुमति देता है। यह देखने के लिए कि टेक्स्ट से इमेज टास्क ऑब्जेक्ट में कौन-कौन से गुण शामिल हैं, The Text to Image Task Object देखें।

पैरामीटर

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, एक उच्च-निष्ठा (high-fidelity) इमेज मॉडल (9 क्रेडिट प्रति इमेज)
- gpt-image-2-5-flare: OpenAI GPT Image 2.5 (Flare), एक उच्च-निष्ठा इमेज मॉडल (9 क्रेडिट प्रति इमेज)
- gpt-image-2-5-sunburst: OpenAI GPT Image 2.5 (Sunburst), एक उच्च-निष्ठा इमेज मॉडल (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
कैरेक्टर जनरेशन के लिए pose_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, gpt-image-2-5-flare, gpt-image-2-5-sunburst: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
उपलब्ध मान:
- 1:1: वर्गाकार फॉर्मेट
- 16:9: वाइडस्क्रीन लैंडस्केप
- 9:16: वाइडस्क्रीन पोर्ट्रेट
- 4:3: स्टैंडर्ड लैंडस्केप
- 3:4: स्टैंडर्ड पोर्ट्रेट
- 3:2: लैंडस्केप (केवल GPT Image मॉडल द्वारा समर्थित)
- 2:3: पोर्ट्रेट (केवल GPT Image मॉडल द्वारा समर्थित)
Name
remove_background
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो जनरेट की गई इमेज बैकग्राउंड हटाकर एक ट्रांसपेरेंट RGBA PNG के रूप में लौटाई जाती है, ताकि आप विषय को किसी भी बैकग्राउंड पर कंपोज़िट कर सकें।

रिटर्न

रिस्पॉन्स की 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 दिए जाने पर टेक्स्ट से इमेज टास्क प्राप्त करने की सुविधा देता है। टेक्स्ट से इमेज टास्क ऑब्जेक्ट में शामिल properties देखने के लिए The Text to Image Task Object देखें।

पैरामीटर

Name
id
Type
path
Description
प्राप्त करने के लिए टेक्स्ट से इमेज टास्क का यूनीक आइडेंटिफ़ायर।

रिटर्न वैल्यू

रिस्पॉन्स में टेक्स्ट से इमेज टास्क ऑब्जेक्ट शामिल होता है। विवरण के लिए The Text to Image Task Object सेक्शन देखें।

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।

टास्क स्टेटस

जो टास्क अभी भी PENDING है, वह डिलीट कर दिया जाता है और क्रिएट-टाइम पर खर्च किए गए क्रेडिट रिफंड कर दिए जाते हैं।

जो टास्क पहले से IN_PROGRESS है, उसे डिलीट नहीं किया जा सकता: रिक्वेस्ट को 409 Conflict के साथ अस्वीकार कर दिया जाता है और टास्क चलता रहता है। जिस टास्क को वर्कर पहले ही शुरू कर चुका है, उसके क्रेडिट रिफंड योग्य नहीं होते, इसलिए उसे बीच में डिलीट करने से आपको क्रेडिट और परिणाम दोनों गंवाने पड़ेंगे। इसके SUCCEEDED, FAILED या CANCELED तक पहुँचने का इंतज़ार करें, फिर इसे डिलीट करें।

कोई टास्क जो अंतिम स्थिति (SUCCEEDED, FAILED या CANCELED) में है, उसे बिना रिफंड के डिलीट कर दिया जाता है।

रिटर्न वैल्यू

सफल होने पर 200 OK रिटर्न करता है, या जब टास्क IN_PROGRESS हो तो 409 Conflict रिटर्न करता है।

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/text-to-image

Text to Image टास्क की सूची

यह एंडपॉइंट आपको Text to Image टास्क की सूची प्राप्त करने की सुविधा देता है।

पैरामीटर्स

Name
page_num
Type
integer
Description
पेजिनेशन के लिए पेज नंबर। शुरुआत और डिफ़ॉल्ट 1 है।
Name
page_size
Type
integer
Description
पेज साइज़ सीमा। डिफ़ॉल्ट रूप से 10 आइटम। अधिकतम अनुमत 100 आइटम है।
Name
sort_by
Type
string
Description
सॉर्ट करने के लिए फ़ील्ड। उपलब्ध मान:
- +created_at: बनाए जाने के समय के अनुसार आरोही क्रम में सॉर्ट करें।
- -created_at: बनाए जाने के समय के अनुसार अवरोही क्रम में सॉर्ट करें।

रिटर्न

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

Text to Image टास्क को स्ट्रीम करें

यह एंडपॉइंट Server-Sent Events (SSE) का उपयोग करके किसी Text to Image टास्क के लिए रीयल-टाइम अपडेट स्ट्रीम करता है।

पैरामीटर

Name
id
Type
path
Description
स्ट्रीम करने के लिए Text to Image टास्क का यूनिक आइडेंटिफ़ायर।

रिटर्न

Server-Sent Events के रूप में The Text to Image Task Objects की एक स्ट्रीम रिटर्न करता है।

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 एक text prompt इनपुट से इमेज जनरेट करने के लिए ट्रैक करता है। ऑब्जेक्ट में निम्नलिखित प्रॉपर्टीज़ होती हैं:

प्रॉपर्टीज़

Name
id
Type
string
Description
टास्क के लिए यूनिक आइडेंटिफ़ायर। हालांकि हम टास्क id के लिए इम्प्लीमेंटेशन डिटेल के रूप में एक k-sortable UUID उपयोग करते हैं, आपको 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, gpt-image-2-5-flare, या gpt-image-2-5-sunburst हैं।
Name
prompt
Type
string
Description
वह टेक्स्ट prompt जिसका उपयोग इमेज जनरेट करने के लिए किया गया था।
Name
status
Type
string
Description
टास्क की स्थिति। संभावित मान PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED में से एक हैं।
Name
progress
Type
integer
Description
टास्क की progress। यदि टास्क अभी शुरू नहीं हुआ है, तो यह प्रॉपर्टी 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
टास्क का परिणाम समाप्त (expire) होने का टाइमस्टैंप, मिलीसेकंड में।
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 हो। FAILED टास्क के लिए 0 लौटाता है (असफल होने पर क्रेडिट वापस कर दिए जाते हैं)।

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
}