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

टेक्स्ट से इमेज API एक विशेषता है जो आपको Meshy की AI इमेज जनरेशन क्षमताओं को आपके अपने एप्लिकेशन में एकीकृत करने की अनुमति देती है। हमारे शक्तिशाली 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 इमेज 2, एक उच्च-विश्वसनीयता वाला इमेज मॉडल (9 क्रेडिट प्रति इमेज)
  • Name
    prompt
    Type
    string
    आवश्यक
    Description

    उस इमेज का टेक्स्ट विवरण जिसे आप जनरेट करना चाहते हैं। सर्वोत्तम परिणामों के लिए वर्णनात्मक बनें।

  • Name
    generate_multi_view
    Type
    boolean
    डिफ़ॉल्ट false
    Description

    जब true पर सेट किया जाता है, तो यह विषय को कई कोणों से दिखाते हुए एक मल्टी-व्यू इमेज जनरेट करता है।

  • 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 पर सेट किया जाता है, तो जनरेट की गई इमेज को एक पारदर्शी 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

    आपने अपनी रेट लिमिट को पार कर लिया है।

अनुरोध

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

प्रतिक्रिया

{
  "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 रिटर्न करता है।

अनुरोध

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

प्रतिक्रिया

// 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 इनपुट से इमेज उत्पन्न करने के लिए ट्रैक करता है। इस ऑब्जेक्ट में निम्नलिखित गुण होते हैं:

गुण

  • Name
    id
    Type
    string
    Description

    कार्य के लिए अद्वितीय पहचानकर्ता। जबकि हम कार्य आईडी के लिए k-sortable UUID का उपयोग करते हैं, आपको आईडी के प्रारूप के बारे में कोई धारणा नहीं बनानी चाहिए।

  • 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

    कार्य कब बनाया गया था इसका टाइमस्टैंप, मिलीसेकंड में।

  • 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

    पूर्ववर्ती कार्यों की संख्या।

  • Name
    image_urls
    Type
    array
    Description

    उत्पन्न इमेज के डाउनलोड करने योग्य URLs की एक श्रृंखला। जब generate_multi_view सक्षम होता है, तो इस श्रृंखला में विभिन्न देखने के कोणों का प्रतिनिधित्व करने वाले तीन इमेज URLs होते हैं। अन्यथा, इसमें एक ही इमेज 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
}