API Konwertuj

API Konwertuj pozwala na konwersję istniejących modeli 3D do różnych formatów plików.

POST/openapi/v1/convert

Utwórz zadanie konwersji

Ten punkt końcowy tworzy nowe zadanie konwersji formatu.

Parametry

Tylko jeden z input_task_id lub model_url jest wymagany. Jeśli oba są podane, input_task_id ma priorytet.

Name
input_task_id
Type
string
Wymagane
Description
ID ukończonego zadania Meshy, którego model chcesz konwertować. Zadanie musi mieć status SUCCEEDED.

Name
model_url
Type
string
Wymagane
Description
Publicznie dostępny URL lub Data URI wskazujący na plik modelu 3D. Obsługiwane formaty: .glb, .gltf, .obj, .fbx, .stl. Dla Data URI użyj MIME type: application/octet-stream.

Name
target_formats
Type
string[]
Wymagane
Description
Lista formatów wyjściowych dla konwertowanego modelu. Dostępne wartości: glb, fbx, obj, usdz, blend, stl, 3mf.

Zwraca

Właściwość result odpowiedzi zawiera id nowo utworzonego zadania konwersji.

Tryby błędów

400 - Bad Request

Żądanie było nieakceptowalne. Typowe przyczyny:

Brakujący parametr: Musi być podany model_url lub input_task_id.
Brakujące target_formats: Musi być określony co najmniej jeden format docelowy.
Nieprawidłowe zadanie wejściowe: input_task_id musi odnosić się do pomyślnego zadania.
Nieprawidłowy format modelu: model_url wskazuje na plik z nieobsługiwanym rozszerzeniem.
Nieosiągalny URL: model_url nie mógł zostać pobrany.

401 - Unauthorized

Uwierzytelnianie nie powiodło się. Proszę sprawdzić swój klucz API.

402 - Payment Required

Niewystarczająca liczba kredytów do wykonania tego zadania.

429 - Too Many Requests

Przekroczyłeś swój limit szybkości.

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

Pobierz zadanie Konwertuj

Ten punkt końcowy pobiera zadanie konwertuj według jego ID.

Parametry

Name
id
Type
path
Description
ID zadania konwertuj do pobrania.

Zwraca

Obiekt zadania Konwertuj.

Request

GET

/openapi/v1/convert/:id

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

Response

{
  "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

Usuń zadanie Konwertuj

Ten punkt końcowy trwale usuwa zadanie konwertuj, w tym wszystkie powiązane modele i dane. Ta akcja jest nieodwracalna.

Parametry ścieżki

Name
id
Type
path
Description
ID zadania konwertuj do usunięcia.

Zwraca

Zwraca 200 OK w przypadku sukcesu.

Żądanie

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}"

Odpowiedź

// Returns 200 Ok on success.

GET/openapi/v1/convert

Lista zadań konwersji

Ten punkt końcowy pozwala na pobranie listy zadań konwersji.

Parametry

Name
page_num
Type
integer
domyślne 1
Description
Numer strony dla stronicowania.

Name
page_size
Type
integer
domyślne 10
Description
Limit rozmiaru strony. Maksymalnie dozwolone to 50 elementów.

Name
sort_by
Type
string
Description
Pole do sortowania. Dostępne wartości:
- +created_at: Sortuj według czasu utworzenia w porządku rosnącym.
- -created_at: Sortuj według czasu utworzenia w porządku malejącym.

Zwraca

Zwraca stronicowaną listę Obiektów Zadań Konwersji.

Request

GET

/openapi/v1/convert

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

Response

[
  {
    "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

Streamowanie zadania konwersji

Ten punkt końcowy przesyła w czasie rzeczywistym aktualizacje dla zadania konwersji przy użyciu Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Unikalny identyfikator dla zadania konwersji do streamowania.

Zwraca

Zwraca strumień Obiektów zadania konwersji jako Server-Sent Events.

Dla zadań PENDING lub IN_PROGRESS, strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i 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
}

Obiekt zadania Konwertuj

Obiekt zadania Konwertuj reprezentuje zadanie konwersji formatu.

Właściwości

id · string

Unikalny identyfikator zadania.

type · string

Typ zadania. Wartość to convert.

model_urls · object

Pobieralne URL-e dla przekonwertowanych plików modelu. Tylko formaty określone w target_formats będą miały URL-e. Inne właściwości formatu będą pustymi ciągami.

progress · integer

Postęp zadania (0-100).

status · string

Status zadania. Możliwe wartości: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · integer

Liczba poprzedzających zadań. Znaczące tylko, gdy status to PENDING.

created_at · znacznik czasu

Znacznik czasu, kiedy zadanie zostało utworzone, w milisekundach.

started_at · znacznik czasu

Znacznik czasu, kiedy zadanie zostało rozpoczęte, w milisekundach. 0 jeśli nie rozpoczęto.

finished_at · znacznik czasu

Znacznik czasu, kiedy zadanie zostało zakończone, w milisekundach. 0 jeśli nie zakończono.

task_error · object

Obiekt błędu, jeśli zadanie nie powiodło się. Zobacz Błędy po więcej szczegółów.

consumed_credits · integer

Liczba kredytów zużytych przez to zadanie (1 kredyt na zadanie konwersji). Zwraca 0 dla zadań FAILED.