vendor_connectors.meshy.rigging
Rigging API - add skeletons to models.
Usage: from vendor_connectors.meshy import rigging
result = rigging.rig(model_task_id)Module Contents
Section titled “Module Contents”Functions
Section titled “Functions”create | Create rigging task. Returns task_id. |
|---|---|
get | Get task status. |
poll | Poll until complete or failed. |
rig | Rig a model for animation. |
rig_from_url | Rig a model from URL. |
vendor_connectors.meshy.rigging.create(request: vendor_connectors.meshy.models.RiggingRequest) → str
Section titled “vendor_connectors.meshy.rigging.create(request: vendor_connectors.meshy.models.RiggingRequest) → str”Create rigging task. Returns task_id.
vendor_connectors.meshy.rigging.get(task_id: str) → vendor_connectors.meshy.models.RiggingResult
Section titled “vendor_connectors.meshy.rigging.get(task_id: str) → vendor_connectors.meshy.models.RiggingResult”Get task status.
vendor_connectors.meshy.rigging.poll(task_id: str, interval: float = 5.0, timeout: float = 600.0) → vendor_connectors.meshy.models.RiggingResult
Section titled “vendor_connectors.meshy.rigging.poll(task_id: str, interval: float = 5.0, timeout: float = 600.0) → vendor_connectors.meshy.models.RiggingResult”Poll until complete or failed.
vendor_connectors.meshy.rigging.rig(model_task_id: str, , height_meters: float = 1.7, wait: bool = True) → vendor_connectors.meshy.models.RiggingResult | str
Section titled “vendor_connectors.meshy.rigging.rig(model_task_id: str, , height_meters: float = 1.7, wait: bool = True) → vendor_connectors.meshy.models.RiggingResult | str”Rig a model for animation.
Args: model_task_id: Task ID of model to rig height_meters: Character height (affects bone scaling) wait: Wait for completion (default True)
Returns: RiggingResult if wait=True, task_id if wait=False
vendor_connectors.meshy.rigging.rig_from_url(model_url: str, , height_meters: float = 1.7, texture_url: str | None = None, wait: bool = True) → vendor_connectors.meshy.models.RiggingResult | str
Section titled “vendor_connectors.meshy.rigging.rig_from_url(model_url: str, , height_meters: float = 1.7, texture_url: str | None = None, wait: bool = True) → vendor_connectors.meshy.models.RiggingResult | str”Rig a model from URL.
Args: model_url: URL to GLB model height_meters: Character height texture_url: Optional texture image URL wait: Wait for completion (default True)
Returns: RiggingResult if wait=True, task_id if wait=False