KardMesh LogoKardMesh
Open studio

DOCUMENTATION

Technical guide, exports & Blender addon

Everything under the hood of KardMesh: export archive layout, advanced generation controls, credit rules, and connecting Blender or external scripts to the API.

1. Export archive & file formats

Every completed generation produces a temporary downloadable ZIP archive containing geometry, UV textures, and metadata for each requested variation.

3D Hair Card Meshes

  • .GLB and .OBJ hair card meshes aligned to the reference head cap.
  • Standalone no-head hair mesh exports for dropping directly onto custom character rigs.
  • UV-mapped color and alpha hair strand textures extracted from the input artwork.

Rigged VRM & Metadata

  • avatar_seed*.vrm — rigged VRM avatar with spring bones (when Animation Bones is enabled).
  • chains_seed*.json — spring-bone chain topology for secondary hair physics.
  • cards_seed*.json and info.json — hair card strip metadata and generation parameters.

The base mannequin included for VRM alignment is dedicated underCC0 1.0. You retain ownership of your input images and receive full personal and commercial rights to generated hair assets.

2. Input specs & advanced generation controls

  • Supported inputs: PNG, JPEG, or WebP character images. Files over 10 MB are automatically compressed in the browser before upload.
  • Variations: 1 variation per job for guests, up to 2 for signed-in free accounts, and up to 4 simultaneous variations after any credit pack or subscription purchase.
  • Priority (Speed vs. Quality): Speed runs 10 inference steps for fast iteration; Quality runs 50 steps for finer strand definition. Both cost 1 credit per variation.
  • Image adherence (CFG): Configurable from1.0 (higher creative freedom) to 4.0(closer adherence to input silhouette). Default is 2.0.
  • Initial seed: Integer between 0 and2147483644 to reproduce a specific generation.
  • Image colors & Animation bones: Toggle source color preservation or monochrome output, and enable VRM spring-bone rigging (signed-in users).

3. Official Blender addon (3.6+) & HTTP API

After purchasing any credit pack or subscription, you can create personal API keys from your account menu inside the studio.

  1. Open your account menu in KardMesh Studio and click Create addon key.
  2. Install the official kardmesh add-on in Blender 3.6 or newer.
  3. Set the API endpoint to https://api.kardmesh.com and paste your personal API key.
  4. Submit images, monitor progress, and import generated hair cards directly from Blender’s Image Editor sidebar.
OpenAPI SpecFull LLM ReferenceAgent Auth GuideMCP Server Card

4. Credits, refunds & data handling

  • Flat rate: 1 generated variation costs 1 credit, with no extra surcharge for Quality mode, adherence, or VRM rigging.
  • Failure protection: Credits are reserved when a job starts and automatically restored if GPU generation fails.
  • Packs vs. subscriptions: One-time credit packs never expire. Monthly and annual plans grant recurring allowances and higher API key limits (1, 5, or 10 keys).
  • No AI training: Uploaded images and temporary ZIP outputs are processed in isolated environments solely to fulfill your request and are never used to train models.

Need help? Contact support@kardmesh.comor review Policies and terms.