Wiele obrazów na 3D API

Wiele obrazów na 3D API to funkcja, która umożliwia zintegrowanie możliwości Wiele obrazów na 3D od Meshy z Twoją własną aplikacją. W tej sekcji znajdziesz wszystkie informacje potrzebne, aby rozpocząć pracę z tym API.

POST/openapi/v1/multi-image-to-3d

Utwórz zadanie Wiele obrazów na 3D

Ten punkt końcowy umożliwia utworzenie nowego zadania Wiele obrazów na 3D. Zajrzyj do Obiektu zadania Wiele obrazów na 3D, aby zobaczyć, jakie właściwości zawiera obiekt zadania Wiele obrazów na 3D.

Parametry

Wymagane jest podanie tylko jednego z input_task_id lub image_urls. Jeśli podane zostaną obie wartości, priorytet ma input_task_id.

Name
input_task_id
Type
string
Wymagane
Description
ID zakończonego zadania generowania obrazu, którego wynik (1-4 obrazy) powinien być użyty jako dane wejściowe. To zadanie musi być jednym z następujących: Tekst na obraz, Obraz na obraz, Tekst na obraz Wiele widoków lub Obraz na obraz Wiele widoków. Ponadto musiało zostać uruchomione za pomocą API i mieć status SUCCEEDED.

Name
image_urls
Type
array
Wymagane
Description
Podaj od 1 do 4 obrazów, które Meshy wykorzysta do stworzenia modelu. Obecnie wspierane formaty to .jpg, .jpeg i .png. Wszystkie obrazy powinny przedstawiać ten sam obiekt z różnych kątów, aby uzyskać najlepsze wyniki.
Istnieją dwa sposoby podania każdego obrazu:
- Publicznie dostępny URL: URL dostępny z publicznego internetu.
- Data URI: Zakodowany w base64 data URI obrazu. Przykład data URI: data:image/jpeg;base64,<twoje zakodowane w base64 dane obrazu>.
Dla meshy-7.1 (lub latest), pierwszy obraz jest używany jako podstawowy widok (z przodu). Kolejność pozostałych obrazów nie ma znaczenia.

Name
ai_model
Type
string
domyślne latest
Description
ID modelu do użycia.
Dostępne wartości:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (przestarzałe): użyj meshy-7.1 zamiast tego.
Name
geometry_resolution
Type
string
domyślne standard
Description
Przebieg generowania geometrii. 2k uruchamia przebieg Ultra przy 2048³. Wymaga meshy-7.1 lub latest.
Dostępne wartości: standard, 2k
Name
ultra_mode
Type
boolean
⚠ przestarzałe
domyślne false
Description
Użyj geometry_resolution zamiast tego. ultra_mode: true jest odpowiednikiem geometry_resolution: "2k".
Name
should_texture
Type
boolean
domyślne true
Description
Określa, czy tekstury są generowane. Ustawienie tej wartości na false pomija fazę teksturowania, dostarczając siatkę bez tekstur.

Dotyczy tylko gdy should_texture = true

Name
enable_pbr
Type
boolean
domyślne false
Description
Generuje mapy PBR (metaliczność, chropowatość, mapa normalnych) w dodatku do koloru podstawowego. Mapa emisji jest również dołączana, gdy ai_model to meshy-6, z wyjątkiem texture_resolution: 8k. meshy-6-lite, meshy-7.1 i latest nie generują mapy emisji.
Name
texture_resolution
Type
string
domyślne 2k
Description
Rozdzielczość tekstury koloru podstawowego. Jedna z: 2k (2048×2048), 4k (4096×4096) lub 8k (8192×8192). Wyższe rozdzielczości uchwytują więcej szczegółów powierzchni.
4k i 8k wymagają ai_model meshy-6, meshy-7.1 lub latest. Przy 8k nie jest generowana mapa emisji.
Name
hd_texture
Type
boolean
⚠ przestarzałe
domyślne false
Description
Użyj texture_resolution zamiast tego — odpowiednik texture_resolution: "4k". Gdy oba są ustawione, priorytet ma texture_resolution.
Name
texture_prompt
Type
string
Description
Podaj prompt tekstowy, aby ukierunkować proces teksturowania. Maksymalnie 800 znaków.
Name
texture_image_url
Type
string
Description
Podaj obraz 2D, aby ukierunkować proces teksturowania. Obecnie wspierane formaty to .jpg, .jpeg i .png.
Istnieją dwa sposoby podania obrazu:
- Publicznie dostępny URL: URL dostępny z publicznego internetu
- Data URI: Zakodowany w base64 data URI obrazu. Przykład data URI: data:image/jpeg;base64,<twoje zakodowane w base64 dane obrazu>
Teksturowanie obrazu może nie działać optymalnie, jeśli istnieją znaczne różnice geometryczne między oryginalnym assetem a przesłanym obrazem. Tylko jeden z texture_image_url lub texture_prompt może być użyty do ukierunkowania procesu teksturowania. Jeśli podane zostaną obie parametry, domyślnie do teksturowania modelu zostanie użyty texture_prompt.
Name
texture_image_urls
Type
string[]
Description
Podaj od 1 do 4 obrazów przedstawiających ten sam obiekt z różnych widoków, aby ukierunkować teksturowanie. Pierwszy obraz jest podstawowym widokiem (z przodu); kolejność pozostałych widoków (lewy, tył, prawy) nie ma znaczenia.
Każdy element przyjmuje te same formaty co texture_image_url (publicznie dostępny URL lub data URI zakodowany w base64, .jpg/.jpeg/.png).
Te obrazy ukierunkowują tylko teksturę i są niezależne od image_urls — obie listy mogą zawierać różne obrazy i różną liczbę obrazów.
Wymaga ai_model meshy-7.1 lub latest. Nie może być łączone z texture_image_url lub texture_prompt.

Name
should_remesh
Type
boolean
domyślne false (Meshy 6 and Meshy 7 models), true (others)
Description
Kontroluje, czy włączyć fazę remesh. Dla modelu najwyższej jakości zalecamy ustawienie should_remesh na false.

Dotyczy tylko gdy should_remesh = true

Name
topology
Type
string
domyślne triangle
Description
Określa topology wygenerowanego modelu.
Dostępne wartości:
- quad: Generuje siatkę z dominacją czworokątów.
- triangle: Generuje zdecymowaną siatkę trójkątów.
Name
target_polycount
Type
integer
domyślne 30,000
Description
Określa docelową liczbę wielokątów w wygenerowanym modelu. Rzeczywista liczba wielokątów może odbiegać od wartości docelowej w zależności od złożoności geometrii.
Prawidłowy zakres wartości różni się w zależności od poziomu użytkownika:
- od 100 do 300 000 (włącznie)
Name
decimation_mode
Type
integer
Description
Włącza adaptacyjną decymację poprzez ustawienie poziomu liczby wielokątów. Gdy ustawiony, target_polycount jest ignorowany.
Dostępne wartości:
- 1: Adaptacyjny — ultra liczba wielokątów.
- 2: Adaptacyjny — wysoka liczba wielokątów.
- 3: Adaptacyjny — średnia liczba wielokątów.
- 4: Adaptacyjny — niska liczba wielokątów.
Name
save_pre_remeshed_model
Type
boolean
domyślne false
Description
Gdy ustawione na true, Meshy przechowuje również dodatkowy plik GLB przed zakończeniem fazy remesh.

Name
symmetry_mode
Type
string
⚠ przestarzałe
domyślne auto
Description
Przestarzałe. Ten parametr nie ma już wpływu na wynik.
Pole symmetry_mode kontroluje zachowanie symetrii podczas procesu generowania modelu.
Prawidłowe wartości to:
- off: Wyłącza symetrię.
- auto: Automatycznie wyznacza i stosuje symetrię na podstawie geometrii wejściowej.
- on: Wymusza symetrię podczas generowania.
Name
pose_mode
Type
string
domyślne ""
Description
Określa pose_mode wygenerowanego modelu.
Dostępne wartości:
- a-pose: Generuje model w pozie A.
- t-pose: Generuje model w pozie T.
- "" (pusty ciąg): Nie zastosowano konkretnej pozy.
Name
is_a_t_pose
Type
boolean
⚠ przestarzałe
domyślne false
Description
Użyj pose_mode zamiast tego. Określa, czy generować model w pozie A/T.
Name
image_enhancement
Type
boolean
domyślne true
Description
Optymalizuje obrazy wejściowe dla lepszych wyników. Ustaw na false, aby zachować dokładny wygląd obrazów wejściowych bez żadnego przetwarzania stylu.
Wspierane tylko wtedy, gdy ai_model to meshy-6, meshy-7.1 lub latest.
Name
remove_lighting
Type
boolean
domyślne true
Description
Usuwa podświetlenia i cienie z tekstury koloru podstawowego, tworząc czystszy wynik, który działa lepiej w niestandardowych konfiguracjach oświetlenia.
Wspierane tylko wtedy, gdy ai_model to meshy-6, meshy-7.1 lub latest.
Name
moderation
Type
boolean
domyślne false
Description
Gdy ustawione na true, treść wejściowa zostanie automatycznie sprawdzona pod kątem potencjalnie szkodliwej zawartości. Jeśli wykryto szkodliwą zawartość, zadanie nie przejdzie do fazy generowania.
Każdy obraz z image_urls oraz tekst z texture_prompt zostaną sprawdzone.
Name
target_formats
Type
string[]
Description
Określa, które formaty plików 3D mają być uwzględnione w wyniku. Zostaną wygenerowane i zwrócone tylko żądane formaty, co może zmniejszyć czas realizacji zadania.
Dostępne wartości: glb, obj, fbx, stl, usdz, 3mf
Gdy pominięte, generowane są wszystkie formaty oprócz 3mf. 3mf jest uwzględniany tylko wtedy, gdy jest wyraźnie określony.
Name
auto_size
Type
boolean
domyślne false
Description
Gdy ustawione na true, usługa wykorzystuje wizję AI do automatycznego oszacowania rzeczywistej wysokości obiektu i odpowiedniego zmiany rozmiaru modelu. Punkt początkowy będzie domyślnie ustawiony na bottom, o ile origin_at nie zostanie wyraźnie ustawiony.
Name
alpha_thumbnail
Type
boolean
domyślne false
Description
Gdy ustawione na true, zadanie dodatkowo renderuje wersję podglądu z przezroczystym tłem (RGBA) i zwraca ją jako alpha_thumbnail_url w odpowiedzi GET. Istniejące pole thumbnail_url pozostaje niezmienione.
Name
multi_view_thumbnails
Type
boolean
domyślne false
Description
Gdy ustawione na true, zadanie dodatkowo renderuje cztery miniatury z widoków kardynalnych (przód, prawa, tył, lewa) i zwraca je w polu thumbnail_urls w odpowiedzi GET. Istniejące pole thumbnail_url pozostaje niezmienione i nadal wskazuje na widok z przodu, więc istniejący klienci nie są tym dotknięci.
Dodaje około 3 sekundy do opóźnienia zadania.

Dotyczy tylko gdy auto_size = true

Name
origin_at
Type
string
domyślne bottom
Description
Pozycja punktu początkowego, gdy auto_size jest włączone. Dostępne wartości: bottom, center.

Zwraca

Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania Wiele obrazów na 3D.

Przypadki niepowodzenia

Name
400 - Bad Request
Description
Żądanie było niedopuszczalne. Najczęstsze przyczyny:
- Brakujący parametr: Musi zostać podane image_urls lub input_task_id.
- Nieprawidłowe zadanie wejściowe: input_task_id musi odnosić się do zadania Tekst na obraz, Obraz na obraz lub wariantu wielu widoków ze statusem SUCCEEDED.
- Nieprawidłowa liczba obrazów: image_urls musi zawierać od 1 do 4 obrazów, a texture_image_urls od 1 do 4.
- Nieprawidłowy format obrazu: Jeden lub więcej obrazów w image_urls ma niewspierany format.
- Konfliktujące dane wejściowe tekstury: texture_image_urls nie może być łączone z texture_image_url lub texture_prompt i wymaga should_texture: true.
- Niewspierany model dla tekstury wielu widoków: texture_image_urls wymaga ai_model meshy-7.1 lub latest.
- Niedostępny URL: Nie można było pobrać jednego lub więcej elementów image_urls lub texture_image_urls.
- Niewspierana rozdzielczość dla wejścia wieloobrazowego: geometry_resolution: "4k" nie jest dostępna dla tego punktu końcowego; użyj 2k lub standard.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczające kredyty do wykonania tego zadania.
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.

Request

POST

/openapi/v1/multi-image-to-3d

# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ]
  }'

# With Ultra 2K geometry, PBR texturing and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "geometry_resolution": "2k",
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/multi-image-to-3d/:id

Pobierz zadanie Wiele obrazów na 3D

Ten punkt końcowy umożliwia pobranie zadania Wiele obrazów na 3D na podstawie prawidłowego identyfikatora zadania id. Zapoznaj się z sekcją Obiekt zadania Wiele obrazów na 3D, aby zobaczyć, jakie właściwości są zawarte w obiekcie zadania Wiele obrazów na 3D.

Parametry

Name
id
Type
path
Description
Unikalny identyfikator zadania Wiele obrazów na 3D, które ma zostać pobrane.

Zwraca

Odpowiedź zawiera obiekt zadania Wiele obrazów na 3D. Szczegóły znajdziesz w sekcji Obiekt zadania Wiele obrazów na 3D.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

DELETE/openapi/v1/multi-image-to-3d/:id

Usuń zadanie Wiele obrazów na 3D

Ten punkt końcowy trwale usuwa zadanie Wiele obrazów na 3D, wraz ze wszystkimi powiązanymi modelami i danymi. Ta czynność jest nieodwracalna.

Parametry ścieżki

Name
id
Type
path
Description
ID zadania Wiele obrazów na 3D, które ma zostać usunięte.

Status zadania

Zadanie, które nadal ma status PENDING, jest usuwane, a kredyty zużyte przy jego tworzeniu są zwracane.

Zadanie, które jest już w stanie IN_PROGRESS, nie może zostać usunięte: żądanie jest odrzucane z kodem 409 Conflict, a zadanie działa dalej. Kredyty za zadanie, które proces roboczy już rozpoczął, nie podlegają zwrotowi, więc usunięcie go w trakcie działania kosztowałoby Cię zarówno kredyty, jak i wynik. Poczekaj, aż osiągnie status SUCCEEDED, FAILED lub CANCELED, a następnie je usuń.

Zadanie w stanie końcowym (SUCCEEDED, FAILED lub CANCELED) jest usuwane bez zwrotu kredytów.

Zwraca

Zwraca 200 OK w przypadku sukcesu lub 409 Conflict, gdy zadanie ma status IN_PROGRESS.

Request

DELETE

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -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/multi-image-to-3d

Lista zadań Wiele obrazów na 3D

Ten punkt końcowy umożliwia pobranie listy zadań Wiele obrazów na 3D.

Parametry

Opcjonalne atrybuty

Name
page_num
Type
integer
Description
Numer strony do stronicowania. Zaczyna się i domyślnie wynosi 1.
Name
page_size
Type
integer
Description
Limit rozmiaru strony. Domyślnie 10 elementów. Maksymalna dozwolona wartość to 100 elementów.
Name
sort_by
Type
string
Description
Pole, według którego ma nastąpić sortowanie. Dostępne wartości:
- +created_at: Sortuj według czasu utworzenia rosnąco.
- -created_at: Sortuj według czasu utworzenia malejąco.

Zwracane dane

Zwraca stronicowaną listę Obiektów zadania Wiele obrazów na 3D.

Request

GET

/openapi/v1/multi-image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 30
  }
]

GET/openapi/v1/multi-image-to-3d/:id/stream

Przesyłaj strumieniowo zadanie Wiele obrazów na 3D

Ten punkt końcowy przesyła strumieniowo aktualizacje w czasie rzeczywistym dla zadania Wiele obrazów na 3D za pomocą Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Unikalny identyfikator zadania Wiele obrazów na 3D do przesyłania strumieniowego.

Zwraca

Zwraca strumień Obiektów zadania Wiele obrazów na 3D jako Server-Sent Events.

Dla zadań o statusie PENDING lub IN_PROGRESS strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
  "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
  "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
  "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
  "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

Obiekt zadania Wiele obrazów na 3D

Obiekt zadania Wiele obrazów na 3D to jednostka pracy, którą Meshy śledzi w celu wygenerowania modelu 3D na podstawie wielu obrazów (od 1 do 4 włącznie). Obrazy powinny przedstawiać ten sam obiekt, najlepiej z różnych widoków lub kątów. Obiekt posiada następujące właściwości:

Właściwości

Name
id
Type
string
Description
Unikalny identyfikator zadania. Chociaż jako szczegół implementacyjny używamy identyfikatora UUID z możliwością sortowania k, nie należy przyjmować żadnych założeń co do formatu tego identyfikatora.
Name
type
Type
string
Description
Typ zadania Wiele obrazów na 3D. Wartość to multi-image-to-3d.
Name
model_urls
Type
object
Description
Adres URL do pobrania pliku modelu 3D z teksturą wygenerowanego przez Meshy. Właściwość dla danego formatu zostanie pominięta, jeśli format nie został wygenerowany, zamiast zwracać pusty ciąg znaków.
- Name
  glb
  Type
  string
  Description
  Adres URL do pobrania pliku GLB.
- Name
  fbx
  Type
  string
  Description
  Adres URL do pobrania pliku FBX.
- Name
  obj
  Type
  string
  Description
  Adres URL do pobrania pliku OBJ.
- Name
  usdz
  Type
  string
  Description
  Adres URL do pobrania pliku USDZ.
- Name
  mtl
  Type
  string
  Description
  Adres URL do pobrania pliku MTL, zwracany razem z eksportem OBJ, gdy obecne są tekstury.
- Name
  stl
  Type
  string
  Description
  Adres URL do pobrania pliku STL.
- Name
  3mf
  Type
  string
  Description
  Adres URL do pobrania pliku 3MF. Obecny tylko wtedy, gdy 3mf zostało zażądane poprzez target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Adres URL do pobrania oryginalnego pliku wyjściowego GLB przed remeshingiem.
  Dostępne tylko wtedy, gdy zadanie zostało utworzone zarówno z should_remesh: true, jak i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Adres URL do pobrania obrazu miniatury pliku modelu. Odpowiednik thumbnail_urls.front, gdy jest obecny, zachowany dla wstecznej kompatybilności.
Name
alpha_thumbnail_url
Type
string
Description
Adres URL do pobrania wersji thumbnail_url z przezroczystym tłem (RGBA). Obecny tylko wtedy, gdy zadanie zostało utworzone z alpha_thumbnail: true, a przezroczysty podgląd został pomyślnie wyrenderowany; w przeciwnym razie to pole jest pomijane.
Name
thumbnail_urls
Type
object
Description
Adresy URL do pobrania czterech miniatur widoków głównych wygenerowanego modelu 3D. Każda wartość to podpisany adres URL do obrazu PNG o rozdzielczości 512×512, wyrenderowanego z tymi samymi materiałami i oświetleniem co thumbnail_url. Przydatne do podglądu modelu z wielu kątów w potokach wsadowych bez konieczności pobierania pliku GLB.
Obecne tylko wtedy, gdy zadanie zostało utworzone z multi_view_thumbnails: true i osiągnęło status SUCCEEDED. Starsze zadania oraz zadania utworzone bez tej opcji nie będą zawierać tego pola.
- Name
  front
  Type
  string
  Description
  Widok z przodu, obrót 0° wokół osi pionowej (odpowiada thumbnail_url).
- Name
  right
  Type
  string
  Description
  Widok z prawej strony, obrót 90°.
- Name
  back
  Type
  string
  Description
  Widok z tyłu, obrót 180°.
- Name
  left
  Type
  string
  Description
  Widok z lewej strony, obrót 270°.
Name
texture_prompt
Type
string
Description
Prompt tekstowy, który został użyty do sterowania procesem teksturowania.
Name
texture_image_urls
Type
string[]
Description
Adresy URL do pobrania obrazów referencyjnych tekstur, które zostały użyte do utworzenia zadania, w kolejności, w jakiej zostały podane. Obecne tylko wtedy, gdy zadanie zostało utworzone z texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ przestarzałe
Description
Przestarzałe; zamiast tego odczytaj geometry_resolution.
Name
geometry_resolution
Type
string
Description
Poziom Ultra, w którym uruchomiono zadanie (2k); pomijane dla standard.
Name
progress
Type
integer
Description
Postęp zadania. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, wartość ta zmieni się na 100.
Name
started_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało rozpoczęte, w milisekundach. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0.
Znacznik czasu reprezentuje liczbę milisekund, która upłynęła od 1 stycznia 1970 UTC, zgodnie ze standardem RFC 3339. Na przykład piątek, 1 września 2023 12:00:00 czasu GMT jest reprezentowany jako 1693569600000. Dotyczy to wszystkich znaczników czasu w Meshy API.
Name
created_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało utworzone, w milisekundach.
Name
expires_at
Type
timestamp
Description
Znacznik czasu, kiedy wynik zadania wygasa, w milisekundach.
Name
finished_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało zakończone, w milisekundach. Jeśli zadanie nie zostało jeszcze zakończone, ta właściwość będzie miała wartość 0.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Tablica obiektów adresów URL tekstur wygenerowanych z zadania. Zwykle zawiera ona tylko jeden obiekt adresu URL tekstury. Każdy adres URL tekstury ma następujące właściwości:
- Name
  base_color
  Type
  string
  Description
  Adres URL do pobrania obrazu mapy koloru bazowego.
- Name
  metallic
  Type
  string
  Description
  Adres URL do pobrania obrazu mapy metaliczności.
  Jeśli zadanie zostało utworzone z enable_pbr: false, ta właściwość zostanie pominięta.
- Name
  normal
  Type
  string
  Description
  Adres URL do pobrania obrazu mapy normalnych.
  Jeśli zadanie zostało utworzone z enable_pbr: false, ta właściwość zostanie pominięta.
- Name
  roughness
  Type
  string
  Description
  Adres URL do pobrania obrazu mapy chropowatości.
  Jeśli zadanie zostało utworzone z enable_pbr: false, ta właściwość zostanie pominięta.
- Name
  emission
  Type
  string
  Description
  Adres URL do pobrania obrazu mapy emisji.
  Jeśli zadanie zostało utworzone z enable_pbr: false, lub ai_model ma wartość meshy-6-lite, ta właściwość zostanie pominięta.
Name
preceding_tasks
Type
integer
Description
Liczba zadań poprzedzających.
Wartość tego pola ma znaczenie tylko wtedy, gdy status zadania to PENDING.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Zobacz Błędy, aby uzyskać pełny opis obiektu task_error.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Obecna, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30,
}