Text to Motion API

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

आउटपुट एक स्टैंडअलोन मोशन क्लिप है: इसके लिए किसी कैरेक्टर मॉडल की आवश्यकता नहीं होती, और यह किसी कैरेक्टर मॉडल से जुड़ा हुआ नहीं होता। पहले किसी कैरेक्टर को रिग करने के लिए, Rigging API देखें। एक जनरेट की गई क्लिप को अपने रिग्ड कैरेक्टर पर लागू करने के लिए, टास्क id को motion_task_id के रूप में एनिमेशन API को पास करें — इसे 3-दिन की एसेट रिटेंशन विंडो के भीतर लागू करें।

POST/openapi/v1/text-to-motion

Create a Text to Motion Task

यह एंडपॉइंट टेक्स्ट prompt से मोशन क्लिप जनरेट करने के लिए एक नया टास्क बनाता है।

यह टास्क बैकग्राउंड में चलता है। इसमें आमतौर पर कितना समय लगता है, यह जानने के लिए Processing Times देखें।

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

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

पैरामीटर

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

रिटर्न्स

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

फेल्यर मोड्स

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

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

Text to Motion टास्क प्राप्त करें

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

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
}

पैरामीटर

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

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

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

GET/openapi/v1/text-to-motion

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

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

प्रतिक्रिया Text to Motion टास्क ऑब्जेक्ट्स की एक array होती है।

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

Request

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

Response

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

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

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

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

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

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message events carry the full task object at every stage; the result
// fields stay empty until the task succeeds.
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: { // Example of a SUCCEEDED task stream item, mirroring The Text to Motion Task Object structure
  "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
}

पैरामीटर

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

रिटर्न

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

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

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

Text to Motion टास्क को डिलीट करें

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

Request

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

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

पाथ पैरामीटर

Name
id
Type
path
Description
डिलीट किए जाने वाले Text to Motion टास्क की ID।

टास्क स्थिति

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

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

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

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

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

Text to Motion Task ऑब्जेक्ट

Text to Motion Task ऑब्जेक्ट किसी टेक्स्ट prompt से मोशन क्लिप जनरेट करने की कार्य इकाई को दर्शाता है।

Properties

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
}

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
टास्क की progress (0-100)।
Name
created_at
Type
timestamp
Description
वह टाइमस्टैंप (एपोक के बाद से मिलीसेकंड) जब टास्क बनाया गया था।
एक टाइमस्टैंप RFC 3339 मानक का पालन करते हुए, 1 जनवरी, 1970 UTC से बीते हुए मिलीसेकंड की संख्या को दर्शाता है। उदाहरण के लिए, शुक्रवार, 1 सितंबर, 2023 दोपहर 12:00:00 GMT को 1693569600000 के रूप में दर्शाया जाता है। यह Meshy API में सभी टाइमस्टैंप पर लागू होता है।
Name
started_at
Type
timestamp
Description
वह टाइमस्टैंप (एपोक के बाद से मिलीसेकंड) जब टास्क ने प्रोसेसिंग शुरू की। यदि शुरू नहीं हुआ तो 0।
Name
finished_at
Type
timestamp
Description
वह टाइमस्टैंप (एपोक के बाद से मिलीसेकंड) जब टास्क समाप्त हुआ। यदि समाप्त नहीं हुआ तो 0।
Name
expires_at
Type
timestamp
Description
वह टाइमस्टैंप (एपोक के बाद से मिलीसेकंड) जब टास्क के परिणामी assets एक्सपायर होते हैं। टास्क समाप्त होने तक यह 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
विफल टास्क के लिए एरर विवरण; जब तक टास्क FAILED न हो, यह null रहता है। पूर्ण task_error ऑब्जेक्ट संदर्भ के लिए एरर देखें।
Name
result
Type
object
Description
टास्क SUCCEEDED होने पर जनरेट की गई मोशन क्लिप शामिल होती है; तब तक फ़ील्ड मौजूद रहती हैं पर खाली ("" / 0) होती हैं।
- Name
  motion_url
  Type
  string
  Description
  जनरेट की गई मोशन क्लिप के लिए डाउनलोड करने योग्य URL। यह URL हर रीड पर फिर से साइन किया जाता है और टास्क की रिटेंशन विंडो के साथ एक्सपायर हो जाता है।
- Name
  motion_format
  Type
  string
  Description
  क्लिप का फ़ाइल फ़ॉर्मेट: prime mode के लिए fbx, swift mode के लिए bvh।
- Name
  duration_ms
  Type
  integer
  Description
  जनरेट की गई क्लिप की अवधि मिलीसेकंड में।
- Name
  mode
  Type
  string
  Description
  वह mode जिससे क्लिप जनरेट की गई थी: prime या swift।