Convert API

Convert API vám umožňuje převést existující 3D modely do různých formátů souborů.

POST/openapi/v1/convert

Vytvoření úkolu pro převod

Tento koncový bod vytváří nový úkol pro převod formátu.

Parametry

Pouze jeden z input_task_id nebo model_url je požadován. Pokud jsou oba poskytnuty, input_task_id má prioritu.

Name
input_task_id
Type
string
Povinné
Description
ID dokončeného úkolu Meshy, jehož model chcete převést. Úkol musí mít status SUCCEEDED.

Name
model_url
Type
string
Povinné
Description
Veřejně přístupná URL nebo data URI ukazující na soubor 3D modelu. Podporované formáty: .glb, .gltf, .obj, .fbx, .stl. Pro Data URI použijte MIME type: application/octet-stream.

Name
target_formats
Type
string[]
Povinné
Description
Seznam výstupních formátů pro převedený model. Dostupné hodnoty: glb, fbx, obj, usdz, blend, stl, 3mf.

Návratové hodnoty

Vlastnost result odpovědi obsahuje id nově vytvořeného úkolu pro převod.

Chybové stavy

400 - Bad Request

Požadavek byl nepřijatelný. Běžné příčiny:

Chybějící parametr: Musí být poskytnut buď model_url nebo input_task_id.
Chybějící target_formats: Musí být specifikován alespoň jeden cílový formát.
Neplatný vstupní úkol: input_task_id musí odkazovat na úspěšný úkol.
Neplatný formát modelu: model_url ukazuje na soubor s nepodporovanou příponou.
Nedosažitelná URL: model_url nemohla být stažena.

401 - Unauthorized

Autentizace selhala. Zkontrolujte prosím svůj API klíč.

402 - Payment Required

Nedostatečné kredity pro provedení tohoto úkolu.

429 - Too Many Requests

Překročili jste svůj limit rychlosti.

Request

POST

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/convert/:id

Načíst úkol převodu

Tento koncový bod načte úkol převodu podle jeho ID.

Parametry

Name
id
Type
path
Description
ID úkolu převodu, který chcete načíst.

Vrátí

Objekt úkolu převodu.

Požadavek

GET

/openapi/v1/convert/:id

curl https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Odpověď

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
      "glb": "",
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "obj": "",
      "usdz": "",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

DELETE/openapi/v1/convert/:id

Smazat úlohu Převést

Tento koncový bod trvale smaže úlohu převést, včetně všech souvisejících modelů a dat. Tato akce je nevratná.

Parametry cesty

Name
id
Type
path
Description
ID úlohy převést ke smazání.

Vrátí

Vrátí 200 OK při úspěchu.

Request

DELETE

/openapi/v1/convert/:id

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/convert

Seznam úkolů pro převod

Tento koncový bod vám umožňuje získat seznam úkolů pro převod.

Parametry

Name
page_num
Type
integer
výchozí 1
Description
Číslo stránky pro stránkování.

Name
page_size
Type
integer
výchozí 10
Description
Limit velikosti stránky. Maximální povolený počet je 50 položek.

Name
sort_by
Type
string
Description
Pole pro řazení. Dostupné hodnoty:
- +created_at: Řadit podle času vytvoření vzestupně.
- -created_at: Řadit podle času vytvoření sestupně.

Návraty

Vrací stránkovaný seznam Objektů úkolů pro převod.

Požadavek

GET

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Odpověď

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

GET/openapi/v1/convert/:id/stream

Streamování úlohy převodu

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

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor pro úlohu převodu ke streamování.

Návratové hodnoty

Vrací stream Objektů úlohy převodu jako Server-Sent Events.

Pro úlohy PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze potřebná pole progress a status.

Request

GET

/openapi/v1/convert/:id/stream

curl -N https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
    "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
    "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Objekt úlohy Převést

Objekt úlohy Převést představuje úlohu pro konverzi formátu.

Vlastnosti

id · string

Unikátní identifikátor úlohy.

type · string

Typ úlohy. Hodnota je convert.

model_urls · object

Stahovatelné URL pro převedené soubory modelu. Pouze formáty specifikované v target_formats budou mít URL. Ostatní vlastnosti formátu budou prázdné řetězce.

progress · integer

Pokrok úlohy (0-100).

status · string

Stav úlohy. Možné hodnoty: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · integer

Počet předcházejících úloh. Má smysl pouze, když je stav PENDING.

created_at · timestamp

Časové razítko, kdy byla úloha vytvořena, v milisekundách.

started_at · timestamp

Časové razítko, kdy byla úloha spuštěna, v milisekundách. 0, pokud nebyla spuštěna.

finished_at · timestamp

Časové razítko, kdy byla úloha dokončena, v milisekundách. 0, pokud nebyla dokončena.

task_error · object

Objekt chyby, pokud úloha selhala. Viz Chyby pro více podrobností.

consumed_credits · integer

Počet kreditů spotřebovaných touto úlohou (1 kredit na úlohu převést). Vrací 0 pro úlohy FAILED.