इमेज से इमेज एपीआई

इमेज से इमेज एपीआई एक विशेषता है जो आपको Meshy की एआई इमेज संपादन क्षमताओं को आपके अपने एप्लिकेशन में एकीकृत करने की अनुमति देती है। हमारे शक्तिशाली एआई मॉडलों के साथ संदर्भ छवियों और टेक्स्ट प्रॉम्प्ट्स का उपयोग करके मौजूदा छवियों को परिवर्तित और संपादित करें।

POST/openapi/v1/image-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, एक उच्च-विश्वसनीयता इमेज एडिट मॉडल (प्रति इमेज 12 क्रेडिट)
Name
prompt
Type
string
आवश्यक
Description
उन ट्रांसफॉर्मेशन या एडिट का टेक्स्ट विवरण जो आप संदर्भ इमेज पर लागू करना चाहते हैं।
Name
reference_image_urls
Type
array
आवश्यक
Description
इमेज एडिटिंग टास्क के लिए उपयोग की जाने वाली 1 से 5 संदर्भ इमेज का एक ऐरे। हम वर्तमान में .jpg, .jpeg, और .png फॉर्मेट्स का समर्थन करते हैं।
प्रत्येक इमेज प्रदान करने के दो तरीके हैं:
- सार्वजनिक रूप से उपलब्ध URL: एक URL जो सार्वजनिक इंटरनेट से एक्सेस किया जा सकता है।
- Data URI: इमेज का बेस64-एन्कोडेड डेटा URI। Data URI का उदाहरण: data:image/jpeg;base64,<आपका बेस64-एन्कोडेड इमेज डेटा>.
Name
generate_multi_view
Type
boolean
डिफ़ॉल्ट false
Description
जब true पर सेट किया जाता है, तो यह विषय को विभिन्न कोणों से दिखाने वाली एक मल्टी-व्यू इमेज उत्पन्न करता है।
जब generate_multi_view true है, तो aspect_ratio पैरामीटर सेट नहीं किया जा सकता।
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, reference_image_urls) गायब है।
- अमान्य इमेज फॉर्मेट: एक या अधिक संदर्भ इमेज समर्थित फॉर्मेट्स नहीं हैं।
- अप्राप्य URL: एक या अधिक reference_image_urls डाउनलोड नहीं किए जा सके।
- अमान्य पैरामीटर: aspect_ratio चयनित ai_model के लिए अनुमत मानों में से एक नहीं है।
- संघर्ष: 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/image-to-image

# Transform a reference image with a text prompt
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>"
    ]
  }'


 ## Using Data URI example
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "data:image/png;base64,${YOUR_BASE64_ENCODED_IMAGE_DATA}"
    ]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-image/:id

इमेज से इमेज टास्क प्राप्त करें

यह एंडपॉइंट आपको एक वैध टास्क id के साथ इमेज से इमेज टास्क प्राप्त करने की अनुमति देता है। इमेज से इमेज टास्क ऑब्जेक्ट में कौन-कौन सी प्रॉपर्टीज़ शामिल हैं, यह देखने के लिए इमेज से इमेज टास्क ऑब्जेक्ट देखें।

पैरामीटर्स

Name
id
Type
path
Description
इमेज से इमेज टास्क के लिए यूनिक पहचानकर्ता जिसे प्राप्त करना है।

रिटर्न्स

प्रतिक्रिया में इमेज से इमेज टास्क ऑब्जेक्ट शामिल होता है। विवरण के लिए इमेज से इमेज टास्क ऑब्जेक्ट अनुभाग देखें।

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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/image-to-image/:id

इमेज से इमेज टास्क को हटाएं

यह एंडपॉइंट एक इमेज से इमेज टास्क को स्थायी रूप से हटाता है, जिसमें सभी संबंधित इमेज और डेटा शामिल हैं। यह क्रिया अपरिवर्तनीय है।

पाथ पैरामीटर्स

Name
id
Type
path
Description
हटाने के लिए इमेज से इमेज टास्क का ID।

रिटर्न्स

सफलता पर 200 OK रिटर्न करता है।

Request

DELETE

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/image-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/image-to-image

curl https://api.meshy.ai/openapi/v1/image-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-image",
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "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/image-to-image/:id/stream

इमेज से इमेज कार्य को स्ट्रीम करें

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

पैरामीटर्स

Name
id
Type
path
Description
इमेज से इमेज कार्य के लिए अद्वितीय पहचानकर्ता जिसे स्ट्रीम करना है।

रिटर्न्स

Server-Sent Events के रूप में इमेज से इमेज कार्य ऑब्जेक्ट्स की एक स्ट्रीम रिटर्न करता है।

PENDING या IN_PROGRESS कार्यों के लिए, प्रतिक्रिया स्ट्रीम केवल आवश्यक progress और status फ़ील्ड्स को शामिल करेगी।

अनुरोध

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

प्रतिक्रिया स्ट्रीम

// 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": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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
छवि उत्पन्न करने के कार्य का प्रकार। इमेज से इमेज कार्यों के लिए, यह हमेशा image-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
उत्पन्न छवियों के डाउनलोड करने योग्य URLs की एक श्रृंखला। जब generate_multi_view सक्षम होता है, तो इस श्रृंखला में विभिन्न देखने के कोणों को दर्शाने वाले तीन छवि URLs होते हैं। अन्यथा, इसमें एकल छवि URL होता है।
Name
task_error
Type
object
Description
विफल कार्यों के लिए एरर विवरण। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए Errors देखें।
Name
consumed_credits
Type
integer
Description
इस कार्य द्वारा उपभोग किए गए क्रेडिट की संख्या। जब कार्य की स्थिति PENDING, IN_PROGRESS, या SUCCEEDED होती है, तब उपस्थित होता है। FAILED कार्यों के लिए 0 लौटाता है (विफलता पर क्रेडिट वापस कर दिए जाते हैं)।

Example Image to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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
}