# Meshy Rigging

> Rig humanoid 3D models from GLB URLs with Meshy, returning rigged GLB/FBX files plus basic   animations.


## Overview

- **Endpoint**: `https://fal.run/fal-ai/meshy/rigging`
- **Model ID**: `fal-ai/meshy/rigging`
- **Category**: 3d-to-3d
- **Kind**: inference
**Tags**: 3d-to-3d, rigging



## Pricing

$0.20 per request. +$0.12 when enable_animation=true ($0.32 total). 

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`model_url`** (`string`, _required_):
  URL of a 3D model in GLB format to rig. Can be any publicly accessible URL — works with models generated by Hunyuan, Trellis, Meshy, or any other 3D generation tool. The model must be a humanoid character with clearly defined limbs.
  - Examples: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"

- **`height_meters`** (`float`, _optional_):
  Approximate height of the character in meters. Default value: `1.7`
  - Default: `1.7`

- **`enable_animation`** (`boolean`, _optional_):
  Apply an animation preset to the rigged model.
  - Default: `false`

- **`animation_action_id`** (`integer`, _optional_):
  Animation preset ID from Meshy's library (500+ presets). Only used when enable_animation is true. See https://docs.meshy.ai/en/api/animation-library for available action IDs. Default value: `1001`
  - Default: `1001`
  - Examples: 1001

- **`enable_safety_checker`** (`boolean`, _optional_):
  If set to true, input data will be checked for safety before processing. Default value: `true`
  - Default: `true`



**Required Parameters Example**:

```json
{
  "model_url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
}
```

**Full Example**:

```json
{
  "model_url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb",
  "height_meters": 1.7,
  "animation_action_id": 1001,
  "enable_safety_checker": true
}
```


### Output Schema

The API returns the following output format:

- **`rigged_character_glb`** (`File`, _optional_):
  Rigged character in GLB format.

- **`rigged_character_fbx`** (`File`, _optional_):
  Rigged character in FBX format.

- **`basic_animations`** (`BasicAnimations`, _optional_):
  Basic walking and running animations included with rigging.

- **`animation_glb`** (`File`, _optional_):
  Animated 3D model in GLB format. Only present when enable_animation is true.

- **`animation_fbx`** (`File`, _optional_):
  Animated 3D model in FBX format. Only present when enable_animation is true.

- **`rig_task_id`** (`string`, _optional_):
  Meshy rigging task ID.



**Example Response**:

```json
{}
```


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/meshy/rigging \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "model_url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/meshy/rigging",
    arguments={
        "model_url": "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

```javascript
import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/meshy/rigging", {
  input: {
    model_url: "https://storage.googleapis.com/falserverless/model_tests/video_models/base_basic_shaded.glb"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/fal-ai/meshy/rigging)
- [API Documentation](https://fal.ai/models/fal-ai/meshy/rigging/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/meshy/rigging)

### fal.ai Platform

- [Platform Documentation](https://docs.fal.ai)
- [Python Client](https://docs.fal.ai/clients/python)
- [JavaScript Client](https://docs.fal.ai/clients/javascript)
