Rigging API

Rigging API vám umožňuje programově přidat kostru (armaturu) k 3D modelům humanoidů a navázat na ni síť, takže jsou připraveny k animaci. Informace o aplikování animací na nařízenou postavu najdete v Animation API.

Vezměte prosím na vědomí, že programové riggování v současné době dobře funguje pouze se standardními humanoidními (dvounohými) assety s jasně definovanými končetinami a strukturou těla.

Create a Rigging Task

Tento koncový bod umožňuje vytvořit novou úlohu riggingu pro daný 3D model. Po úspěšném dokončení poskytne riggovanou postavu ve standardních formátech a volitelně základní animace chůze/běhu.

Úloha běží na pozadí. Jak dlouho to obvykle trvá, zjistíte v sekci Processing Times.

V současné době není automatický rigging vhodný pro následující modely:

Sítě bez textury
Assety, které nejsou humanoidní
Humanoidní assety s nejasnou strukturou končetin a těla

Při použití input_task_id nejsou pro rigging podporovány modely s více než 300 000 polygony. Pro snížení počtu polygonů před riggingem použijte prosím Remesh API.

Při použití model_url musí obličej postavy směřovat k ose +Z (standardní dopředný směr glTF). U modelů orientovaných jiným směrem selže odhad pozice.

Parametry

Je vyžadováno pouze jedno z input_task_id nebo model_url. Pokud jsou zadány oba, má input_task_id přednost.

Name
input_task_id
Type
string
Povinné
Description
Vstupní úloha, kterou je třeba riggovat. V současné době podporujeme texturované humanoidní modely.

Name
model_url
Type
string
Povinné
Description
Poskytněte prosím 3D model, který má Meshy riggovat, prostřednictvím veřejně dostupné URL adresy nebo Data URI. V současné době podporujeme texturované humanoidní soubory GLB (formát .glb).
Maximální velikost souboru: 400 MB pro http nebo https URL, 100 MB pro data: URI.
Soubor nad 100 MB s více než 10 000 000 polygony vrátí 400. Polygony se počítají jako trojúhelníky a síť vykreslená vícekrát se počítá jednou za každou kopii. Soubor GLB nad 100 MB nesmí používat kompresi Draco.

Name
height_meters
Type
number
výchozí 1.7
Description
Přibližná výška modelu postavy v metrech. Pomáhá při přesnosti škálování a riggingu. Musí se jednat o kladné číslo.
Name
texture_image_url
Type
string
Description
Základní barevná textura modelu s UV rozložením. Veřejně dostupná URL adresa nebo Data URI. V současné době podporujeme formáty .png.
Maximální velikost souboru: 20 MB.

Návratová hodnota

Vlastnost result odpovědi obsahuje id úlohy nově vytvořené úlohy riggingu.

Režimy selhání

Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
- Chybějící parametr: Musí být zadáno buď model_url, nebo input_task_id.
- Neplatný formát modelu: model_url odkazuje na soubor s nepodporovanou příponou (podporován je pouze .glb).
- Nedostupná URL adresa: model_url se nepodařilo stáhnout.
- Soubor modelu je příliš velký: Soubor model_url přesahuje 400 MB (URL http nebo https) nebo 100 MB (data: URI).
- Příliš mnoho polygonů: Soubor model_url je větší než 100 MB a má více než 10 000 000 polygonů. Snižte počet polygonů a poté soubor odešlete znovu.
- Nečitelný soubor modelu: Soubor model_url je větší než 100 MB a jeho hlavičku nelze přečíst, například u GLB komprimovaného pomocí Draco.
- Hlavička modelu je příliš složitá: Soubor model_url je větší než 100 MB a jeho hlavička obsahuje příliš mnoho sítí, uzlů nebo záznamů ke kontrole. Snižte počet objektů v souboru a poté jej odešlete znovu.
- Obrázek je příliš velký: Obrázek texture_image_url přesahuje 20 MB.
- Neplatná vstupní úloha: input_task_id neodkazuje na platnou úlohu API.
- Překročen počet polygonů: Vstupní model má více než 300 000 polygonů. Pro snížení počtu polygonů před riggingem použijte prosím Remesh API.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatek kreditů k provedení této úlohy.
Name
422 - Unprocessable Entity
Description
Odhad pozice se nezdařil. Poskytnutý model možná není platnou humanoidní postavou.
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.

Request

POST

/openapi/v1/rigging

# Rig a model from a URL
curl https://api.meshy.ai/openapi/v1/rigging \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "YOUR_MODEL_URL_OR_DATA_URI",
    "height_meters": 1.8
  }'

Response

{
  "result": "018b314a-a1b5-716d-c222-2f1776f7f579"
}

GET/openapi/v1/rigging/:id

Získání úlohy riggingu

Tento koncový bod umožňuje získat úlohu riggingu na základě platného id úlohy. Podrobnosti o tom, které vlastnosti jsou zahrnuty, naleznete v části Objekt úlohy riggingu.

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy riggingu, kterou chcete získat.

Návratová hodnota

Odpověď obsahuje objekt úlohy riggingu. Podrobnosti naleznete v části Objekt úlohy riggingu.

Request

GET

/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579

curl https://api.meshy.ai/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}

DELETE/openapi/v1/rigging/:id

Smazání úkolu riggingu

Tento koncový bod trvale smaže úkol riggingu, včetně všech souvisejících modelů a dat. Tato akce je nevratná.

Parametry cesty

Name
id
Type
path
Description
ID úkolu riggingu, který má být smazán.

Stav úkolu

Úkol, který je stále ve stavu PENDING, je smazán a kredity spotřebované při jeho vytvoření jsou vráceny.

Úkol, který je již ve stavu IN_PROGRESS, nelze smazat: požadavek je odmítnut s 409 Conflict a úkol pokračuje v běhu. Kredity za úkol, který worker již začal zpracovávat, nejsou vratné, takže jeho smazání v průběhu zpracování by vás stálo kredity i výsledek zároveň. Počkejte, až dosáhne stavu SUCCEEDED, FAILED nebo CANCELED, a poté jej smažte.

Úkol v koncovém stavu (SUCCEEDED, FAILED nebo CANCELED) je smazán bez vrácení kreditů.

Návratové hodnoty

Při úspěchu vrací 200 OK, nebo 409 Conflict, pokud je úkol ve stavu IN_PROGRESS.

Request

DELETE

/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/rigging

List Rigging Tasks

Vrací stránkovaný seznam volajícího úkolů riggingu, seřazený od nejnovějších. Standardní stránkování pomocí page_num a page_size.

Všimněte si, že úkoly vytvořené přes API jsou spravovány přes API — v My Assets webové aplikace se neobjevují. Použijte tento koncový bod k nalezení úkolu, jehož ID už nemáte.

Request

GET

/openapi/v1/rigging

curl "https://api.meshy.ai/openapi/v1/rigging?page_num=1&page_size=20" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

GET/openapi/v1/rigging/:id/stream

Streamování úlohy riggingu

Tento koncový bod streamuje aktualizace v reálném čase pro úlohu riggingu pomocí Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Unikátní identifikátor úlohy riggingu, kterou chcete streamovat.

Návratová hodnota

Vrací stream objektů úlohy riggingu jako Server-Sent Events.

U úloh se stavem PENDING nebo IN_PROGRESS bude datový proud odpovědi obsahovat pouze nezbytná pole progress a status.

Request

GET

/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/stream

curl -N https://api.meshy.ai/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Rigging Task Object structure
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/.../Character_output.fbx?...",
    "rigged_character_glb_url": "https://assets.meshy.ai/.../Character_output.glb?...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.glb?...",
      "walking_fbx_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.fbx?...",
      "walking_armature_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin_armature.glb?...",
      "running_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.glb?...",
      "running_fbx_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.fbx?...",
      "running_armature_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin_armature.glb?..."
    }
  },
  "preceding_tasks": 0
}

Objekt úkolu riggingu

Objekt úkolu riggingu reprezentuje pracovní jednotku pro rigging postavy.

Vlastnosti

Name
id
Type
string
Description
Jedinečný identifikátor úkolu.
Name
type
Type
string
Description
Typ úkolu riggingu. Hodnota je rig.
Name
status
Type
string
Description
Stav úkolu. Možné hodnoty: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress úkolu (0–100). 0, pokud nebyl zahájen, 100, pokud byl úspěšný.
Name
created_at
Type
timestamp
Description
Časové razítko (v milisekundách od epochy) vytvoření úkolu.
Časové razítko představuje počet milisekund uplynulých od 1. ledna 1970 UTC podle standardu RFC 3339. Například pátek 1. září 2023 12:00:00 GMT je reprezentován jako 1693569600000. To platí pro všechna časová razítka v Meshy API.
Name
started_at
Type
timestamp
Description
Časové razítko (v milisekundách od epochy) zahájení zpracování úkolu. 0, pokud nebyl zahájen.
Name
finished_at
Type
timestamp
Description
Časové razítko (v milisekundách od epochy) dokončení úkolu. 0, pokud nebyl dokončen.
Name
expires_at
Type
timestamp
Description
Časové razítko (v milisekundách od epochy), kdy vyprší platnost výstupních assetů úkolu a mohou být smazány.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úkolů. Úplný popis objektu task_error najdete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Je přítomno, pokud je stav úkolu PENDING, IN_PROGRESS nebo SUCCEEDED. U úkolů se stavem FAILED vrací 0 (při selhání jsou kredity vráceny).
Name
result
Type
object
Description
Obsahuje URL adresy výstupních assetů, pokud úkol skončil se stavem SUCCEEDED, jinak null.
- Name
  rigged_character_fbx_url
  Type
  string
  Description
  URL ke stažení riggované postavy ve formátu FBX.
- Name
  rigged_character_glb_url
  Type
  string
  Description
  URL ke stažení riggované postavy ve formátu GLB.
- Name
  basic_animations
  Type
  object (optional)
  Description
  Obsahuje URL adresy výchozích animací. (Např. pokud bylo generate_basic_animations implicitně true nebo povoleno ve výchozím nastavení.)
  Name
  walking_glb_url
  Type
  string
  Description
  URL ke stažení animace chůze ve formátu GLB (s kůží).
  Name
  walking_fbx_url
  Type
  string
  Description
  URL ke stažení animace chůze ve formátu FBX (s kůží).
  Name
  walking_armature_glb_url
  Type
  string
  Description
  URL ke stažení armatury animace chůze ve formátu GLB.
  Name
  running_glb_url
  Type
  string
  Description
  URL ke stažení animace běhu ve formátu GLB (s kůží).
  Name
  running_fbx_url
  Type
  string
  Description
  URL ke stažení animace běhu ve formátu FBX (s kůží).
  Name
  running_armature_glb_url
  Type
  string
  Description
  URL ke stažení armatury animace běhu ve formátu GLB.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů ve frontě. Má smysl pouze v případě, že stav je PENDING.

Example Rigging Task Object

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}