टेक्स्ट टू मोशन एपीआई

प्राकृतिक भाषा विवरणों से चरित्र गति क्लिप्स उत्पन्न करें। एक क्रिया का वर्णन करें — "एक चरित्र हाथ हिला रहा है", "एक ज़ोंबी आगे की ओर लड़खड़ा रहा है" — और एक कच्चा गति क्लिप प्राप्त करें जिसे आप अपने स्वयं के पाइपलाइन या DCC टूल्स में rigged चरित्रों पर पुनः लक्ष्य कर सकते हैं।

आउटपुट एक स्वतंत्र गति क्लिप है: इसे एक चरित्र मॉडल की आवश्यकता नहीं है, और न ही इसे उससे संलग्न किया गया है। पहले एक चरित्र को rig करने के लिए, Rigging API देखें।

POST/openapi/v1/text-to-motion

टेक्स्ट को मोशन टास्क बनाएं

यह endpoint एक नए टास्क को बनाने के लिए टेक्स्ट prompt से मोशन क्लिप उत्पन्न करता है।

'mode' 'prime' के साथ एक टास्क की कीमत 10 क्रेडिट होती है और यह हमारे उच्च-गुणवत्ता वाले मोशन मॉडल के साथ उत्पन्न होती है। 'mode' 'swift' के साथ एक टास्क की कीमत 3 क्रेडिट होती है और यह हमारे किफायती मोशन मॉडल के साथ तेजी से उत्पन्न होती है।

पैरामीटर्स

Name
prompt
Type
string
आवश्यक
Description
उत्पन्न करने के लिए मोशन का प्राकृतिक-भाषा विवरण। अधिकतम 400 वर्ण।
Name
mode
Type
string
डिफ़ॉल्ट prime
Description
मोशन जनरेशन मोड। उपलब्ध मान: prime, swift। 'prime' उच्चतम गुणवत्ता उत्पन्न करता है और FBX आउटपुट करता है; 'swift' तेज़ और सस्ता है और BVH आउटपुट करता है।
Name
duration
Type
number
आवश्यक
Description
मोशन क्लिप की लक्षित अवधि सेकंडों में। 2 से 10 के बीच, 0.5 के स्टेप्स में (उदाहरण के लिए 2, 2.5, 3, … 10)।

रिटर्न्स

प्रतिक्रिया की result प्रॉपर्टी में हाल ही में बनाए गए टेक्स्ट को मोशन टास्क का टास्क id होता है।

विफलता मोडस

Name
400 - Bad Request
Description
अनुरोध अस्वीकार्य था। सामान्य कारण:
- लापता या खाली prompt: prompt गायब है, खाली है, या 400 वर्णों से अधिक लंबा है।
- अमान्य mode: mode prime या swift नहीं है।
- अमान्य अवधि: duration गायब है, 2–10 के बाहर है, या 0.5 सेकंड के स्टेप पर नहीं है।
Name
401 - Unauthorized
Description
प्रमाणीकरण विफल हुआ। कृपया अपनी API की जांचें।
Name
402 - Payment Required
Description
इस टास्क को करने के लिए अपर्याप्त क्रेडिट।
Name
403 - Forbidden
Description
prompt को कंटेंट moderation ने फ़्लैग किया।
Name
429 - Too Many Requests
Description
आपने अपनी रेट लिमिट को पार कर लिया है।

Request

POST

/openapi/v1/text-to-motion

# Generate a motion clip with required params only
curl https://api.meshy.ai/openapi/v1/text-to-motion \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "prompt": "a character waving",
    "duration": 3
  }'

# Generate a fast, economical clip with Swift mode
curl https://api.meshy.ai/openapi/v1/text-to-motion \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "prompt": "a character waving",
    "mode": "swift",
    "duration": 4.5
  }'

Response

{
  "result": "018c425b-b2c6-727e-d333-3c1887i9h791"
}

GET/openapi/v1/text-to-motion/:id

टेक्स्ट टू मोशन टास्क प्राप्त करें

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

पैरामीटर्स

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

रिटर्न्स

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

Request

GET

/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791

curl https://api.meshy.ai/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "text-to-motion",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1787314497437,
  "started_at": 1787314498012,
  "finished_at": 1787314505881,
  "expires_at": 1787573705881,
  "task_error": null,
  "result": {
    "motion_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/clip.fbx?Expires=...",
    "motion_format": "fbx",
    "duration_ms": 3000,
    "mode": "prime"
  },
  "consumed_credits": 10
}

GET/openapi/v1/text-to-motion

Text to Motion कार्यों की सूची

कॉलर के Text to Motion कार्यों की पेजिनेटेड सूची लौटाता है, नवीनतम पहले। page_num और page_size के माध्यम से मानक पेजिनेशन।

प्रतिक्रिया Text to Motion Task objects का एक एरे है।

ध्यान दें कि API के माध्यम से बनाए गए कार्य API के माध्यम से प्रबंधित होते हैं — वे वेब ऐप के My Assets में दिखाई नहीं देते। किसी कार्य को ढूंढने के लिए इस एंडपॉइंट का उपयोग करें जिसका ID आपके पास नहीं है।

अनुरोध

GET

/openapi/v1/text-to-motion

curl "https://api.meshy.ai/openapi/v1/text-to-motion?page_num=1&page_size=20" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

प्रतिक्रिया

[
  {
    "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
    "type": "text-to-motion",
    "status": "SUCCEEDED",
    "...": "..."
  }
]

GET/openapi/v1/text-to-motion/:id/stream

टेक्स्ट टू मोशन टास्क स्ट्रीम करें

यह एंडपॉइंट सर्वर-सेंट इवेंट्स (SSE) का उपयोग करते हुए टेक्स्ट टू मोशन टास्क के लिए रीयल-टाइम अपडेट को स्ट्रीम करता है।

पैरामीटर्स

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

रिटर्न्स

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

हर message इवेंट पूरे टास्क ऑब्जेक्ट को वाहक करता है। जब तक टास्क PENDING या IN_PROGRESS है, तब तक result फील्ड खाली ("" / 0) रहते हैं और finished_at / expires_at 0 हैं; status और progress को देखें।

Request

GET

/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791/stream

curl -N https://api.meshy.ai/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// एरर इवेंट उदाहरण
event: error
data: {
  "status_code": 404,
  "message": "टास्क नहीं मिला"
}

// संदेश इवेंट हर चरण में पूरे टास्क ऑब्जेक्ट को ले जाते हैं; परिणाम
// फील्ड तब तक खाली रहती हैं जब तक टास्क सफल नहीं हो जाता।
event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "text-to-motion",
  "status": "IN_PROGRESS",
  "progress": 50,
  "created_at": 1787314497437,
  "started_at": 1787314498012,
  "finished_at": 0,
  "expires_at": 0,
  "task_error": null,
  "result": {
    "motion_url": "",
    "motion_format": "",
    "duration_ms": 0,
    "mode": ""
  },
  "consumed_credits": 10
}

event: message
data: { // सफल कार्य स्ट्रीम आइटम का उदाहरण, टेक्स्ट टू मोशन टास्क ऑब्जेक्ट स्ट्रक्चर का अनुकरण करता हुआ
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "text-to-motion",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1787314497437,
  "started_at": 1787314498012,
  "finished_at": 1787314505881,
  "expires_at": 1787573705881,
  "task_error": null,
  "result": {
    "motion_url": "https://assets.meshy.ai/.../output/clip.fbx?Expires=...",
    "motion_format": "fbx",
    "duration_ms": 3000,
    "mode": "prime"
  },
  "consumed_credits": 10
}

DELETE/openapi/v1/text-to-motion/:id

टेक्स्ट टू मोशन कार्य को डिलीट करें

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

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

Name
id
Type
path
Description
डिलीट करने के लिए टेक्स्ट टू मोशन कार्य की आईडी।

रिटर्न्स

सफलता पर 200 OK लौटाता है।

रिप्रेस्ट

DELETE

/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

रिस्पॉन्स

// सफल होने पर 200 Ok लौटाता है।

टेक्स्ट टू मोशन टास्क ऑब्जेक्ट

टेक्स्ट टू मोशन टास्क ऑब्जेक्ट एक कार्य इकाई का प्रतिनिधित्व करता है जो टेक्स्ट prompt से मोशन क्लिप उत्पन्न करने के लिए है।

गुण

Name
id
Type
string
Description
कार्य के लिए अनोखा पहचानकर्ता।
Name
type
Type
string
Description
कार्य का प्रकार। मान है text-to-motion।
Name
status
Type
string
Description
कार्य की स्थिति। संभावित मान: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED।
Name
progress
Type
integer
Description
कार्य की प्रगति (0-100)।
Name
created_at
Type
timestamp
Description
समय मोहर (epoch के बाद मिलीसेकंड में) जब कार्य बनाया गया था।
एक समय मोहर जनवरी 1, 1970 UTC के बाद से बिताए गए मिलीसेकंड की संख्या का प्रतिनिधित्व करता है, जो RFC 3339 मानक के अनुसार है। उदाहरण के लिए, शुक्रवार, सितंबर 1, 2023 12:00:00 अपराह्न GMT को 1693569600000 के रूप में दर्शाया जाता है। यह सभी समय मोहरों पर Meshy API में लागू होता है।
Name
started_at
Type
timestamp
Description
समय मोहर (epoch के बाद मिलीसेकंड में) जब कार्य का प्रसंस्करण शुरू हुआ। 0 अगर शुरू नहीं हुआ।
Name
finished_at
Type
timestamp
Description
समय मोहर (epoch के बाद मिलीसेकंड में) जब कार्य समाप्त हुआ। 0 अगर समाप्त नहीं हुआ।
Name
expires_at
Type
timestamp
Description
समय मोहर (epoch के बाद मिलीसेकंड में) जब कार्य के परिणामगत asset की समाप्ति होती है। 0 जब तक कार्य समाप्त नहीं होता। उत्पन्न क्लिप कार्य के समाप्त होने के 3 दिन बाद तक रखी जाती है; इसे समाप्ति से पहले डाउनलोड करें।
Name
preceding_tasks
Type
integer
Description
कतार में पूर्ववर्ती कार्यों की गिनती। केवल तब सार्थक जब स्थिति PENDING है; जब शून्य हो तब छूटता है।
Name
consumed_credits
Type
integer
Description
इस कार्य द्वारा उपभोग की गई क्रेडिट की संख्या। prime mode के लिए 10, swift mode के लिए 3। FAILED कार्यों के लिए 0 लौटाता है (असफलता पर क्रेडिट वापस कर दिए जाते हैं)।
Name
task_error
Type
object
Description
असफल कार्यों के लिए त्रुटि विवरण; null जब तक कार्य FAILED नहीं होता। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए Errors देखें।
Name
result
Type
object
Description
जब कार्य SUCCEEDED हो जाता है तब उत्पन्न मोशन क्लिप वाला ऑब्जेक्ट। तब तक क्षेत्र मौजूद लेकिन खाली रहते हैं ("" / 0)।
- Name
  motion_url
  Type
  string
  Description
  उत्पन्न मोशन क्लिप के लिए डाउनलोड करने योग्य यूआरएल। यूआरएल हर रीड पर पुनः हस्ताक्षरित होता है और कार्य की रिटेंशन विंडो के साथ समाप्त होता है।
- Name
  motion_format
  Type
  string
  Description
  क्लिप का फ़ाइल प्रारूप: fbx के लिए prime mode, bvh के लिए swift mode।
- Name
  duration_ms
  Type
  integer
  Description
  उत्पन्न क्लिप की अवधि मिलीसेकंड में।
- Name
  mode
  Type
  string
  Description
  वह mode जिसके साथ क्लिप उत्पन्न की गई: prime या swift।

Example Text to Motion Task Object

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "text-to-motion",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1787314497437,
  "started_at": 1787314498012,
  "finished_at": 1787314505881,
  "expires_at": 1787573705881,
  "task_error": null,
  "result": {
    "motion_url": "https://assets.meshy.ai/.../output/clip.fbx?Expires=...",
    "motion_format": "fbx",
    "duration_ms": 3000,
    "mode": "prime"
  },
  "consumed_credits": 10
}