Flera bilder till 3D API

Generera en 3D-modell från en till fyra bilder av samma objekt, tagna från olika vinklar.

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

Skapa en Flera bilder till 3D-uppgift

Skapar en Flera bilder till 3D-uppgift. Uppgiften körs i bakgrunden. För hur lång tid en uppgift vanligtvis tar, se Bearbetningstider. För vilka fält en uppgift har, se Objektet för Flera bilder till 3D-uppgiften.

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

# Textured with Meshy N1 from the input images, the first as the front view
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 front view image url or base64-encoded data URI>",
      "<your back view image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "texture_model": "meshy-n1"
  }'

Response

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

Parametrar

Name
input_task_id
Type
string
Obligatorisk
Description
Krävs om du inte skickar image_urls. ID:t för en Text till bild- eller Bild till bild-uppgift, inklusive en flervy-uppgift. Meshy använder dess en till fyra bilder som indata. Uppgiften måste vara en som du skapat med API:et och som har statusen SUCCEEDED.

Name
image_urls
Type
array
Obligatorisk
Description
Krävs om du inte skickar input_task_id. En till fyra bilder, var och en som en offentlig URL eller en data-URI, till exempel data:image/jpeg;base64,<din base64-kodade bilddata>. Om du skickar båda använder Meshy input_task_id.
Varje bild måste vara en .jpg-, .jpeg-, .png- eller .webp-fil på högst 20 MB, minst 32 pixlar på varje sida och högst 178 956 970 pixlar (bredd × höjd). Fler än fyra bilder returnerar 400.
För bästa resultat bör bilderna visa samma objekt från olika vinklar. Med meshy-7.1 eller latest använder Meshy den första bilden som framvy, och ordningen på de övriga spelar ingen roll.

Name
ai_model
Type
string
standard latest
Description
AI-modellen som genererar 3D-modellen.
Tillgängliga värden:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: föråldrad, skicka meshy-7.1 istället
Name
geometry_resolution
Type
string
standard standard
Description
Hur mycket geometridetalj som ska genereras.
Tillgängliga värden:
- standard
- 2k: kör Ultra-passet vid 2048³. Kräver meshy-7.1, latest, eller den föråldrade meshy-7.
Name
ultra_mode
Type
boolean
⚠ föråldrad
standard false
Description
Skicka geometry_resolution istället. ultra_mode: true är detsamma som geometry_resolution: "2k".
Name
should_texture
Type
boolean
standard true
Description
Om texturer ska genereras. true returnerar en texturerad modell, och false hoppar över textursteget och returnerar ett nät utan texturer.

Gäller endast när should_texture = true

Name
texture_model
Type
string
standard depends on ai_model
Description
AI-modellen som texturerar 3D-modellen från flera vyer, i samma uppgift. Utelämna den för att använda standard-texturmodellen för din ai_model. Det ändrar inte credits-kostnaden.
Tillgängliga värden:
- meshy-7: Meshy 7, med PBR-mappar och texturer upp till 8K
- meshy-n1: Meshy N1, en 2K-basfärgstextur enbart från referensbilder
Varje ai_model tar båda. En texturerad begäran med meshy-6 eller meshy-6-lite returnerar 400, liksom ett alternativ som den valda texturmodellen inte stöder. Med should_texture: false ignorerar Meshy texture_model, men ett okänt värde returnerar ändå 400.
Med meshy-n1 texturerar Meshy från texture_image_urls eller texture_image_url, eller från inmatningsbilderna när du inte skickar någon av dem. Den första bilden är framvyn. En genererad modell över 7 999 999 trianglar misslyckas med uppgiften, och Meshy återbetalar dess credits.
Se Modeller för vad varje texturmodell gör och vilken du bör välja.
Name
enable_pbr
Type
boolean
standard false
Description
Om metallic-, roughness- och normal-mappar också ska genereras, utöver basfärgen. Texturmodellen Meshy 6 genererar även en emissionsmapp, förutom vid texture_resolution: 8k. Med texture_model: meshy-n1 returnerar true``400.
Name
texture_resolution
Type
string
standard 2k
Description
Storleken på basfärgstexturen. En större storlek fångar mer ytdetalj.
Tillgängliga värden:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
4k och 8k kräver texturmodellen Meshy 7 eller Meshy 6, och returnerar 400 med de andra. Vid 8k genererar Meshy ingen emissionsmapp.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Skicka texture_resolution istället. hd_texture: true är detsamma som texture_resolution: "4k". Om du skickar båda använder Meshy texture_resolution.
Name
texture_prompt
Type
string
Description
Text som styr texturen, upp till 800 tecken. Längre text returnerar 400. Med texture_model: meshy-n1 returnerar en sådan begäran 400.
Name
texture_image_url
Type
string
Description
En 2D-bild som styr texturen, som en offentlig URL eller en data-URI, till exempel data:image/jpeg;base64,<din base64-kodade bilddata>. Bilden måste vara en .jpg-, .jpeg-, .png- eller .webp-fil på högst 20 MB, minst 32 pixlar på varje sida och högst 178 956 970 pixlar (bredd × höjd).
Om du skickar både texture_image_url och texture_prompt använder Meshy texture_prompt. Med texture_model: meshy-n1 texturerar Meshy från denna bild som framvy.
Texturen kanske inte blir bra när formen i bilden skiljer sig mycket från 3D-modellen.
Name
texture_image_urls
Type
string[]
Description
En till fyra bilder av objektet från olika vyer som styr texturen. Meshy använder den första bilden som framvy. Ordningen på de övriga vyerna (vänster, bak, höger) spelar ingen roll.
Varje bild följer samma regler som texture_image_url. Det är en offentlig URL eller en data-URI, i .jpg-, .jpeg-, .png- eller .webp-format, på högst 20 MB, minst 32 pixlar på varje sida och högst 178 956 970 pixlar (bredd × höjd).
Dessa bilder styr endast texturen och beror inte på image_urls. De två listorna kan innehålla olika bilder och olika antal bilder.
texture_image_urls kräver texturmodellen Meshy 7 eller Meshy N1. Skicka den tillsammans med någon av dessa:
- ai_model av meshy-7.1, latest, eller den föråldrade meshy-7
- texture_model av meshy-7 eller meshy-n1
Du kan inte skicka den tillsammans med texture_image_url eller texture_prompt.

Name
should_remesh
Type
boolean
standard true (meshy-6-lite), false (other models)
Description
Om modellen ska remeshas efter generering. För den högsta kvaliteten på 3D-modellen, sätt den till false.

Gäller endast när should_remesh = true

Name
topology
Type
string
standard triangle
Description
Yttypen för den remeshade modellen.
Tillgängliga värden:
- quad: ett övervägande fyrhörnsnät
- triangle: ett decimerat triangelnät
Med texture_model: meshy-n1 returnerar quad``400 när modellen remeshas, vilket meshy-6-lite gör som standard.
Name
target_polycount
Type
integer
standard 30000
Description
Antalet ytor att sikta mot, från 100 till 300000. Resultatet kan skilja sig från målet, beroende på modellens geometri. Ett värde utanför intervallet returnerar 400.
Name
decimation_mode
Type
integer
Description
Adaptivt antal ytor, efter nivå. När du anger denna ignorerar Meshy target_polycount.
Tillgängliga värden:
- 1: ultra
- 2: hög
- 3: medel
- 4: låg
Name
save_pre_remeshed_model
Type
boolean
standard false
Description
Om GLB:n från innan remesh också ska sparas, returnerad i model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ föråldrad
standard auto
Description
Utelämna den. Den påverkar inte utdata.
Tillgängliga värden:
- off: ingen symmetri
- auto: symmetri baserad på indatageometrin
- on: framtvingad symmetri
Name
pose_mode
Type
string
standard ""
Description
Positionen för den genererade modellen.
Tillgängliga värden:
- a-pose: en A-position
- t-pose: en T-position
- "" (tom sträng): ingen specifik position
Name
is_a_t_pose
Type
boolean
⚠ föråldrad
standard false
Description
Skicka pose_mode istället. Om modellen ska genereras i A- eller T-position.
Name
image_enhancement
Type
boolean
standard true
Description
Om indatabilderna ska optimeras innan generering. false behåller exakt utseende på indatabilderna, utan stilbearbetning. Stöds endast med meshy-6, meshy-7.1, eller latest. Att skicka den med meshy-6-lite returnerar 400.
Name
remove_lighting
Type
boolean
standard true
Description
Om höjdpunkter och skuggor ska tas bort från basfärgstexturen. Det renare resultatet fungerar bättre under din egen belysning. Endast texturmodellen Meshy 6 använder den, och vid texture_resolution: 8k tas belysningen alltid bort. Med texture_model: meshy-n1 returnerar true``400. Med ai_model: meshy-6-lite och dess standard-texturmodell returnerar en sådan begäran 400.
Name
moderation
Type
boolean
standard false
Description
Om indata ska granskas för skadligt innehåll. Meshy granskar varje indatabild, texture_image_url eller varje bild i texture_image_urls, och texten i texture_prompt. Om Meshy hittar skadligt innehåll returnerar begäran 400 och Meshy skapar ingen uppgift.
Name
target_formats
Type
string[]
Description
3D-filformaten som ska genereras. Meshy genererar och returnerar endast de format du listar, vilket kan korta ner uppgiften.
Tillgängliga värden:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Om du utelämnar den genererar Meshy alla format utom 3mf. Meshy genererar 3mf endast när du listar det.
Name
auto_size
Type
boolean
standard false
Description
Om objektets verkliga höjd ska uppskattas med AI-synfunktion och modellen ändra storlek till den. Meshy placerar origot vid botten om du inte anger origin_at.

Gäller endast när auto_size = true

Name
origin_at
Type
string
standard bottom
Description
Var modellens origo ska placeras, bottom eller center.

Name
alpha_thumbnail
Type
boolean
standard false
Description
Om en förhandsvisning med transparent bakgrund (RGBA) också ska renderas, returnerad i alpha_thumbnail_url när du hämtar uppgiften. thumbnail_url ändras inte.
Name
multi_view_thumbnails
Type
boolean
standard false
Description
Om förhandsvisningar för fram, höger, bak och vänster också ska renderas, returnerade i thumbnail_urls när du hämtar uppgiften. thumbnail_url ändras inte och visar fortfarande framvyn. Detta lägger till cirka 5 sekunder till uppgiften.

Returnerar

Fältet result i svaret innehåller ID:t för den nya Flera bilder till 3D-uppgiften.

Felmoder

Name
400 - Bad Request
Description
Begäran kan inte köras. Felmeddelandet anger vilket problem som hittades. Till exempel:
- Saknad parameter: Varken image_urls eller input_task_id skickades.
- Ogiltig indatauppgift: input_task_id är inte en SUCCEEDED Text till bild- eller Bild till bild-uppgift, eller en flervy-uppgift.
- Ogiltigt antal bilder: image_urls eller texture_image_urls innehåller inte 1 till 4 bilder.
- Ogiltigt bildformat: En bild i image_urls är inte i ett format som stöds.
- Motstridiga texturindata: texture_image_urls skickades tillsammans med texture_image_url, med texture_prompt, eller med should_texture: false.
- Modell stöds inte för flervy-textur: texture_image_urls skickades med ai_model av meshy-6 eller meshy-6-lite, om inte texture_model är meshy-7 eller meshy-n1.
- Oåtkomlig URL: Meshy kan inte ladda ner en bild i image_urls eller texture_image_urls.
- Bilden för stor: En bild i image_urls, texture_image_url, eller texture_image_urls är över 20 MB.
- Ogiltig bildstorlek: En bild i image_urls, texture_image_url, eller texture_image_urls har en sida kortare än 32 pixlar, eller fler än 178 956 970 pixlar (bredd × höjd).
- Upplösning stöds inte för flerbildsindata: geometry_resolution är "4k", vilket denna endpoint inte stöder. Använd 2k eller standard.
- Modell stöds inte för bildalternativ: image_enhancement skickades med ai_model: "meshy-6-lite", eller remove_lighting skickades med ai_model: "meshy-6-lite" och dess standard-texturmodell.
- Ogiltig texturmodell: texture_model är inte ett giltigt texturmodellnamn.
- Texturmodell inte tillgänglig: En texturerad begäran skickade texture_model av meshy-6 eller meshy-6-lite. Flera bilder till 3D tar endast de texturmodeller som texturerar från flera vyer. Skicka meshy-7 eller meshy-n1, eller utelämna texture_model.
- Alternativ stöds inte för texturmodellen: Begäran ber texturmodellen om ett alternativ den inte stöder, till exempel enable_pbr: true med meshy-n1 eller en 4k-textur med meshy-6-lite. Se Modeller.
Rätta begäran och skicka den igen. Se Fel.
Name
401 - Unauthorized
Description
API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-headern.
Name
402 - Payment Required
Description
Till exempel:
- Otillräckliga credits: Kontot har inte tillräckligt med credits för denna uppgift, eller kontot har nått en creditsgräns. Kontrollera ditt credits-saldo och försök sedan igen.
- Gratisplan: Att skapa en uppgift kräver en betald plan. Uppgradera din plan i dina prenumerationsinställningar och försök sedan igen.
Name
403 - Forbidden
Description
Innehållsmoderering blockerade prompten eller en indatabild. Ändra indatan och försök sedan igen.
Name
404 - Not Found
Description
input_task_id matchar ingen av dina uppgifter. Kontrollera uppgifts-ID:t och skicka sedan begäran igen.
Name
429 - Too Many Requests
Description
Du överskred din hastighetsgräns. Vänta och försök sedan igen. Se Hastighetsgränser.

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

Hämta en uppgift för Flera bilder till 3D

Returnerar en Flera bilder till 3D-uppgift utifrån dess ID.

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID:t från skapandesvaret.

Returnerar

Objektet för Flera bilder till 3D-uppgiften.

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

Ta bort en Flera bilder till 3D-uppgift

Tar permanent bort en Flera bilder till 3D-uppgift, inklusive dess modeller och data. Du kan inte ångra en borttagning.

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

Sökvägsparametrar

Name
id
Type
path
Description
ID för uppgiften som ska tas bort.

Uppgiftsstatus

Om du tar bort en PENDING-uppgift återbetalas de credits som användes när du skapade den.

En IN_PROGRESS-uppgift kan inte tas bort. Begäran returnerar 409 Conflict, och uppgiften fortsätter att köras. Meshy återbetalar inte en uppgift som har påbörjats, så att ta bort den skulle kosta dig både krediterna och resultatet. Vänta tills den når SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.

Om du tar bort en uppgift med en slutgiltig status (SUCCEEDED, FAILED eller CANCELED) återbetalas inte dess credits.

Returnerar

200 OK när uppgiften har tagits bort, eller 409 Conflict när uppgiften är IN_PROGRESS.

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

Lista uppgifter för Flera bilder till 3D

Returnerar en lista över dina uppgifter för Flera bilder till 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"
      }
    ],
    "preceding_tasks": 0,
    "task_error": null,

    "consumed_credits": 30
  }
]

Parametrar

Name
page_num
Type
integer
standard 1
Description
Sidnumret som ska returneras, upp till 255. Ett större värde returnerar 400.
Name
page_size
Type
integer
standard 10
Description
Antalet uppgifter per sida, upp till 100.
Name
sort_by
Type
string
Description
Sorteringsordningen.
Tillgängliga värden:
- +created_at: äldsta först
- -created_at: nyaste först

Returnerar

En paginerad lista med uppgiftsobjekt för Flera bilder till 3D.

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

Strömma en Flera bilder till 3D-uppgift

Strömmar uppdateringar för en Flera bilder till 3D-uppgift som Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID från skapandesvaret.

Returnerar

En ström av Flera bilder till 3D-uppgiftsobjekt som Server-Sent Events.

Varje händelse innehåller hela uppgiftsobjektet, i samma format som Get-endpointen returnerar. Medan uppgiften är PENDING eller IN_PROGRESS saknar dess resultatfält fortfarande värden.

Objektet för Flera bilder till 3D-uppgiften

Ett objekt för Flera bilder till 3D-uppgiften beskriver en generering av en 3D-modell från en till fyra bilder av ett objekt. Det innehåller status, progress och modellfilerna när uppgiften lyckas.

Egenskaper

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Name
id
Type
string
Description
Uppgifts-ID. Behandla det som en ogenomskinlig sträng och förlita dig inte på dess format.
Name
type
Type
string
Description
Uppgiftstypen, alltid multi-image-to-3d.
Name
model_urls
Type
object
Description
Nedladdnings-URL:er för den genererade 3D-modellen, en per filformat. Ett format som uppgiften inte genererade saknar nyckel, i stället för en tom sträng.
- Name
  glb
  Type
  string
  Description
  GLB-filen.
- Name
  fbx
  Type
  string
  Description
  FBX-filen.
- Name
  obj
  Type
  string
  Description
  OBJ-filen.
- Name
  usdz
  Type
  string
  Description
  USDZ-filen.
- Name
  mtl
  Type
  string
  Description
  MTL-filen, returneras tillsammans med OBJ-filen när modellen har texturer.
- Name
  stl
  Type
  string
  Description
  STL-filen.
- Name
  3mf
  Type
  string
  Description
  3MF-filen. Finns endast när target_formats inkluderar 3mf.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  GLB-filen från innan remesh. Finns endast när du skapade uppgiften med både should_remesh: true och save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Nedladdnings-URL för en förhandsgranskningsbild av modellen. Den är densamma som thumbnail_urls.front när det fältet finns.
Name
alpha_thumbnail_url
Type
string
Description
Nedladdnings-URL för en version av thumbnail_url med transparent bakgrund (RGBA). Finns endast när du skapade uppgiften med alpha_thumbnail: true och Meshy renderade den transparenta förhandsgranskningen.
Name
thumbnail_urls
Type
object
Description
Nedladdnings-URL:er för förhandsgranskningar av 3D-modellen från fyra sidor. Var och en är en signerad URL till en 512×512 PNG, renderad med samma material och belysning som thumbnail_url. Du kan använda dem för att förhandsgranska modellen från flera vinklar utan att ladda ner GLB-filen.
Finns endast när du skapade uppgiften med multi_view_thumbnails: true och uppgiften nådde SUCCEEDED. En uppgift skapad utan multi_view_thumbnails: true har inte detta fält.
- Name
  front
  Type
  string
  Description
  Vyn framifrån, vid 0° runt den vertikala axeln. Den matchar thumbnail_url.
- Name
  right
  Type
  string
  Description
  Vyn från höger, vid 90°.
- Name
  back
  Type
  string
  Description
  Vyn bakifrån, vid 180°.
- Name
  left
  Type
  string
  Description
  Vyn från vänster, vid 270°.
Name
texture_prompt
Type
string
Description
Textprompten som styrde texturen.
Name
texture_image_urls
Type
string[]
Description
Nedladdnings-URL:er för texturreferensbilderna du skapade uppgiften med, i den ordning du skickade dem. Finns endast när du skapade uppgiften med texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ föråldrad
Description
Läs geometry_resolution i stället.
Name
geometry_resolution
Type
string
Description
Ultra-nivån som uppgiften kördes i, vilket är 2k. En standard-uppgift har inte detta fält.
Name
progress
Type
integer
Description
Hur stor del av uppgiften som är klar, i procent. Den är 0 tills uppgiften startar och 100 när den lyckas.
Name
started_at
Type
timestamp
Description
Tidpunkt då uppgiften startade, i Unix-millisekunder. Den är 0 tills uppgiften startar.
Name
created_at
Type
timestamp
Description
Tidpunkt då uppgiften skapades, i Unix-millisekunder.
Name
expires_at
Type
timestamp
Description
Tidpunkt då uppgiftens resultat upphör att gälla, i Unix-millisekunder.
Name
finished_at
Type
timestamp
Description
Tidpunkt då uppgiften avslutades, i Unix-millisekunder. Den är 0 tills uppgiften avslutas.
Name
status
Type
string
Description
Uppgiftens status, en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED eller CANCELED.
Name
texture_urls
Type
array
Description
Nedladdnings-URL:er för de texturkartor som uppgiften genererade, som en array av objekt. Den innehåller vanligtvis ett objekt. Varje objekt har dessa fält:
- Name
  base_color
  Type
  string
  Description
  Baskulör-kartan (base color).
- Name
  metallic
  Type
  string
  Description
  Den metalliska kartan. Ingår inte när du skapade uppgiften med enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Normalmappen. Ingår inte när du skapade uppgiften med enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Ojämnhetskartan (roughness). Ingår inte när du skapade uppgiften med enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Emissionskartan. Ingår endast när du skapade uppgiften med allt av följande:
  
  ai_model: meshy-6, med dess standardtexturmodell
  
  enable_pbr: true
  
  en texture_resolution på 2k eller 4k
Name
preceding_tasks
Type
integer
Description
Antalet uppgifter före denna i kön. Värdet är endast meningsfullt medan uppgiften är PENDING.
Name
task_error
Type
object
Description
Feldetaljerna när uppgiften misslyckas. Den är null om inte statusen är FAILED. Se Fel.
Name
consumed_credits
Type
integer
Description
Antalet credits som uppgiften använde. Finns när statusen är PENDING, IN_PROGRESS eller SUCCEEDED. Den är 0 för en FAILED-uppgift, eftersom Meshy återbetalar credits när en uppgift misslyckas.