API Overview

What the API is for

The AIMoCap API is built for:

• internal production pipelines
• creator tools
• enterprise integrations
• robot motion automation workflows

The API is asynchronous. A typical flow is:

1. create a mocap job
2. upload the source video
3. complete upload admission
4. poll job status
5. download the finished result

Output targets

The public API uses targetIds to describe one or more outputs for a single mocap job. The currently supported public target ids are:

• default
• unitree_g1

Output formats depend on the target:

• default -> fbx
• unitree_g1 -> robot_motion_json

Custom avatar targets are planned for a later public API update. They are not part of the current documented API surface.

Export FPS

The optional exportFps field currently supports:

• 24
• 30
• 60
• 120

If exportFps is omitted, AIMoCap uses 30 by default.

If the value is invalid, the create-job request fails immediately with:

• export_fps_invalid

Capture Type

The optional mocapType field controls the capture mode:

• full_body
• upper_body

If mocapType is omitted, AIMoCap uses full_body by default.

If the value is invalid, the create-job request fails immediately with:

• mocap_type_invalid

Other checks that can be decided before queue admission also fail at create or complete-upload time:

• api_duration_limit_exceeded
• api_file_size_limit_exceeded
• api_concurrency_limit_exceeded
• api_plan_inactive
• insufficient_api_v_credits

API key and billing

The API uses a dedicated API key and a dedicated v-credit balance.

• Web credits and API v-credit are billed separately and do not share balance.
• 1 v-credit = 1 second of admitted video
• requests are admitted only when your API account is active and within plan limits

Read the detailed docs next:

• Authentication
• Reference
• Pricing