Rigs API

The Rigs API allows you to manage character rig configurations for motion capture processing.

List Rigs

Get a list of available character rigs.

curl -X GET https://api.move.ai/v1/rigs \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "rigs": [
    {
      "id": "rig_default",
      "name": "Default Humanoid",
      "description": "Standard humanoid character rig",
      "joint_count": 23,
      "created_at": "2023-01-01T00:00:00Z"
    }
  ],
  "total": 1
}

Get Rig Details

Retrieve detailed information about a specific rig.

curl -X GET https://api.move.ai/v1/rigs/rig_default \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "rig_default",
  "name": "Default Humanoid",
  "description": "Standard humanoid character rig",
  "joint_count": 23,
  "joints": [
    {
      "name": "Hips",
      "parent": null,
      "position": [0, 0, 0]
    },
    {
      "name": "Spine",
      "parent": "Hips",
      "position": [0, 0.1, 0]
    }
  ],
  "created_at": "2023-01-01T00:00:00Z"
}

Create Custom Rig

Create a custom character rig configuration.

curl -X POST https://api.move.ai/v1/rigs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Custom Character",
    "description": "Custom rig for my character",
    "joints": [
      {
        "name": "Hips",
        "parent": null,
        "position": [0, 0, 0]
      }
    ]
  }'

Request Parameters

Parameter	Type	Required	Description
name	String	Yes	Name of the rig
description	String	No	Description of the rig
joints	Array	Yes	Array of joint definitions

Response

{
  "id": "rig_custom_123",
  "name": "Custom Character",
  "description": "Custom rig for my character",
  "joint_count": 1,
  "created_at": "2023-01-01T00:00:00Z"
}

Update Rig

Update an existing custom rig.

curl -X PUT https://api.move.ai/v1/rigs/rig_custom_123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Character",
    "description": "Updated custom rig"
  }'

Response

{
  "id": "rig_custom_123",
  "name": "Updated Character",
  "description": "Updated custom rig",
  "joint_count": 1,
  "updated_at": "2023-01-01T00:00:00Z"
}

Delete Rig

Delete a custom rig (only works for rigs you created).

curl -X DELETE https://api.move.ai/v1/rigs/rig_custom_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "success": true,
  "message": "Rig deleted successfully"
}

Joint Structure

Each joint in a rig has the following properties:

Property	Type	Description
name	String	Unique name for the joint
parent	String	Name of the parent joint (null for root)
position	Array	3D position [x, y, z]

Default Rigs

The following rigs are available by default:

• rig_default: Standard humanoid character (23 joints)
• rig_simple: Simplified humanoid (15 joints)
• rig_detailed: Detailed humanoid (30 joints)

Next Steps

• Jobs API - Create processing jobs
• Takes API - Retrieve motion capture data
• Files API - Upload video files