Multi-afbeelding naar 3D API

Genereer een 3D-model uit één tot vier afbeeldingen van hetzelfde object, genomen vanuit verschillende hoeken.

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

Een Multi-afbeelding naar 3D-taak maken

Maakt een Multi-afbeelding naar 3D-taak. De taak draait op de achtergrond. Voor hoe lang een taak meestal duurt, zie Verwerkingstijden. Voor de velden van een taak, zie Het Multi-afbeelding naar 3D-taakobject.

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

Parameters

Name
input_task_id
Type
string
Verplicht
Description
Vereist, tenzij je image_urls meestuurt. De ID van een Tekst naar afbeelding- of Afbeelding naar afbeelding-taak, inclusief een met meerdere aanzichten. Meshy gebruikt de één tot vier afbeeldingen ervan als invoer. De taak moet er een zijn die je met de API hebt gemaakt en de status SUCCEEDED hebben.

Name
image_urls
Type
array
Verplicht
Description
Vereist, tenzij je input_task_id meestuurt. Eén tot vier afbeeldingen, elk als een openbare URL of een data-URI, zoals data:image/jpeg;base64,<je base64-gecodeerde afbeeldingsgegevens>. Als je beide meestuurt, gebruikt Meshy input_task_id.
Elke afbeelding moet een .jpg-, .jpeg-, .png- of .webp-bestand zijn van maximaal 20 MB, minimaal 32 pixels aan elke zijde, en maximaal 178.956.970 pixels (breedte × hoogte). Meer dan vier afbeeldingen geeft 400 terug.
Voor de beste resultaten moeten de afbeeldingen hetzelfde object vanuit verschillende hoeken tonen. Met meshy-7.1 of latest gebruikt Meshy de eerste afbeelding als vooraanzicht, en de volgorde van de andere maakt niet uit.

Name
ai_model
Type
string
standaard latest
Description
Het AI-model dat het 3D-model genereert.
Beschikbare waarden:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: verouderd, stuur in plaats daarvan meshy-7.1
Name
geometry_resolution
Type
string
standaard standard
Description
Hoeveel geometriedetail er gegenereerd moet worden.
Beschikbare waarden:
- standard
- 2k: voert de Ultra-pass uit op 2048³. Vereist meshy-7.1, latest, of het verouderde meshy-7.
Name
ultra_mode
Type
boolean
⚠ verouderd
standaard false
Description
Stuur in plaats daarvan geometry_resolution. ultra_mode: true is hetzelfde als geometry_resolution: "2k".
Name
should_texture
Type
boolean
standaard true
Description
Of er textures gegenereerd moeten worden. true geeft een getextureerd model terug, en false slaat de texturestap over en geeft een mesh zonder textures terug.

Alleen van toepassing wanneer should_texture = true

Name
texture_model
Type
string
standaard depends on ai_model
Description
Het AI-model dat het 3D-model vanuit meerdere aanzichten textuurt, in dezelfde taak. Laat dit weg om het standaard texturemodel voor je ai_model te gebruiken. Het verandert de creditkosten niet.
Beschikbare waarden:
- meshy-7: Meshy 7, met PBR-maps en textures tot 8K
- meshy-n1: Meshy N1, een 2K basiskleurtexture alleen op basis van referentieafbeeldingen
Elk ai_model accepteert beide. Een getextureerd verzoek met meshy-6 of meshy-6-lite geeft 400 terug, net als een optie die het gekozen texturemodel niet ondersteunt. Met should_texture: false negeert Meshy texture_model, maar een onbekende waarde geeft nog steeds 400 terug.
Met meshy-n1 textuurt Meshy op basis van texture_image_urls of texture_image_url, of op basis van de invoerafbeeldingen wanneer je geen van beide meestuurt. De eerste afbeelding is het vooraanzicht. Een gegenereerd model met meer dan 7.999.999 driehoeken laat de taak mislukken, en Meshy betaalt de credits ervan terug.
Zie Modellen voor wat elk texturemodel doet en welke je moet kiezen.
Name
enable_pbr
Type
boolean
standaard false
Description
Of er, naast de basiskleur, ook metallic-, roughness- en normal-maps gegenereerd moeten worden. Het Meshy 6-texturemodel genereert ook een emissiemap, behalve bij texture_resolution: 8k. Met texture_model: meshy-n1 geeft true 400 terug.
Name
texture_resolution
Type
string
standaard 2k
Description
De grootte van de basiskleurtexture. Een grotere grootte legt meer oppervlaktedetail vast.
Beschikbare waarden:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
4k en 8k vereisen het Meshy 7- of Meshy 6-texturemodel, en geven 400 terug bij de andere. Bij 8k genereert Meshy geen emissiemap.
Name
hd_texture
Type
boolean
⚠ verouderd
standaard false
Description
Stuur in plaats daarvan texture_resolution. hd_texture: true is hetzelfde als texture_resolution: "4k". Als je beide meestuurt, gebruikt Meshy texture_resolution.
Name
texture_prompt
Type
string
Description
Tekst die de texture stuurt, tot 800 tekens. Langere tekst geeft 400 terug. Met texture_model: meshy-n1 geeft het meesturen hiervan 400 terug.
Name
texture_image_url
Type
string
Description
Eén 2D-afbeelding die de texture stuurt, als een openbare URL of een data-URI, zoals data:image/jpeg;base64,<je base64-gecodeerde afbeeldingsgegevens>. De afbeelding moet een .jpg-, .jpeg-, .png- of .webp-bestand zijn van maximaal 20 MB, minimaal 32 pixels aan elke zijde, en maximaal 178.956.970 pixels (breedte × hoogte).
Als je zowel texture_image_url als texture_prompt meestuurt, gebruikt Meshy texture_prompt. Met texture_model: meshy-n1 textuurt Meshy op basis van deze afbeelding als vooraanzicht.
De texture komt mogelijk niet goed uit wanneer de vorm in de afbeelding sterk afwijkt van het 3D-model.
Name
texture_image_urls
Type
string[]
Description
Eén tot vier afbeeldingen van het object vanuit verschillende aanzichten die de texture sturen. Meshy gebruikt de eerste afbeelding als vooraanzicht. De volgorde van de andere aanzichten (links, achter, rechts) maakt niet uit.
Elke afbeelding volgt dezelfde regels als texture_image_url. Het is een openbare URL of een data-URI, in .jpg-, .jpeg-, .png- of .webp-formaat, van maximaal 20 MB, minimaal 32 pixels aan elke zijde, en maximaal 178.956.970 pixels (breedte × hoogte).
Deze afbeeldingen sturen alleen de texture en zijn niet afhankelijk van image_urls. De twee lijsten kunnen verschillende afbeeldingen en verschillende aantallen afbeeldingen bevatten.
texture_image_urls vereist het Meshy 7- of Meshy N1-texturemodel. Stuur het met een van deze mee:
- ai_model van meshy-7.1, latest, of het verouderde meshy-7
- texture_model van meshy-7 of meshy-n1
Je kunt het niet meesturen met texture_image_url of texture_prompt.

Name
should_remesh
Type
boolean
standaard true (meshy-6-lite), false (other models)
Description
Of het model na generatie geremesht moet worden. Voor het 3D-model van de hoogste kwaliteit stel je dit in op false.

Alleen van toepassing wanneer should_remesh = true

Name
topology
Type
string
standaard triangle
Description
Het gezichtstype van het geremeshte model.
Beschikbare waarden:
- quad: een mesh die voornamelijk uit vierhoeken bestaat
- triangle: een gereduceerde driehoeksmesh
Met texture_model: meshy-n1 geeft quad 400 terug wanneer het model wordt geremesht, wat meshy-6-lite standaard doet.
Name
target_polycount
Type
integer
standaard 30000
Description
Het aantal vlakken om naar te streven, van 100 tot 300000. Het resultaat kan afwijken van het doel, afhankelijk van de geometrie van het model. Een waarde buiten het bereik geeft 400 terug.
Name
decimation_mode
Type
integer
Description
Adaptief aantal vlakken, per niveau. Wanneer je dit instelt, negeert Meshy target_polycount.
Beschikbare waarden:
- 1: ultra
- 2: hoog
- 3: gemiddeld
- 4: laag
Name
save_pre_remeshed_model
Type
boolean
standaard false
Description
Of ook de GLB van vóór de remesh opgeslagen moet worden, teruggegeven in model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ verouderd
standaard auto
Description
Laat dit weg. Het heeft geen invloed op de uitvoer.
Beschikbare waarden:
- off: geen symmetrie
- auto: symmetrie op basis van de invoergeometrie
- on: afgedwongen symmetrie
Name
pose_mode
Type
string
standaard ""
Description
De pose van het gegenereerde model.
Beschikbare waarden:
- a-pose: een A-pose
- t-pose: een T-pose
- "" (lege string): geen specifieke pose
Name
is_a_t_pose
Type
boolean
⚠ verouderd
standaard false
Description
Stuur in plaats daarvan pose_mode. Of het model in een A- of T-pose gegenereerd moet worden.
Name
image_enhancement
Type
boolean
standaard true
Description
Of de invoerafbeeldingen geoptimaliseerd moeten worden vóór generatie. false behoudt de exacte uitstraling van de invoerafbeeldingen, zonder stijlbewerking. Alleen ondersteund met meshy-6, meshy-7.1, of latest. Het meesturen ervan met meshy-6-lite geeft 400 terug.
Name
remove_lighting
Type
boolean
standaard true
Description
Of hooglichten en schaduwen uit de basiskleurtexture verwijderd moeten worden. Het schonere resultaat werkt beter onder je eigen belichting. Alleen het Meshy 6-texturemodel gebruikt dit, en bij texture_resolution: 8k verwijdert het altijd de belichting. Met texture_model: meshy-n1 geeft true 400 terug. Met ai_model: meshy-6-lite en het bijbehorende standaard texturemodel geeft het meesturen hiervan 400 terug.
Name
moderation
Type
boolean
standaard false
Description
Of de invoer gescreend moet worden op schadelijke inhoud. Meshy screent elke invoerafbeelding, texture_image_url of elke afbeelding in texture_image_urls, en de tekst in texture_prompt. Als Meshy schadelijke inhoud vindt, geeft het verzoek 400 terug en maakt Meshy geen taak aan.
Name
target_formats
Type
string[]
Description
De 3D-bestandsformaten om te genereren. Meshy genereert en geeft alleen de formaten terug die je opgeeft, wat de taak kan verkorten.
Beschikbare waarden:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Als je dit weglaat, genereert Meshy elk formaat behalve 3mf. Meshy genereert 3mf alleen wanneer je het opgeeft.
Name
auto_size
Type
boolean
standaard false
Description
Of de werkelijke hoogte van het object geschat moet worden met AI-visie en het model daarnaar in grootte aangepast moet worden. Meshy plaatst de oorsprong onderaan, tenzij je origin_at instelt.

Alleen van toepassing wanneer auto_size = true

Name
origin_at
Type
string
standaard bottom
Description
Waar de oorsprong van het model geplaatst moet worden, bottom of center.

Name
alpha_thumbnail
Type
boolean
standaard false
Description
Of er ook een voorbeeld gerenderd moet worden met een transparante achtergrond (RGBA), teruggegeven in alpha_thumbnail_url wanneer je de taak ophaalt. thumbnail_url verandert niet.
Name
multi_view_thumbnails
Type
boolean
standaard false
Description
Of er ook voorbeelden van vooraanzicht, rechts, achterkant en links gerenderd moeten worden, teruggegeven in thumbnail_urls wanneer je de taak ophaalt. thumbnail_url verandert niet en toont nog steeds het vooraanzicht. Dit voegt ongeveer 5 seconden toe aan de taak.

Retourwaarden

Het veld result van de respons bevat de ID van de nieuwe Multi-afbeelding naar 3D-taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek kan niet worden uitgevoerd. Het foutbericht vermeldt welk probleem is gevonden. Bijvoorbeeld:
- Ontbrekende parameter: Noch image_urls noch input_task_id is meegestuurd.
- Ongeldige invoertaak: input_task_id is geen SUCCEEDED Tekst naar afbeelding- of Afbeelding naar afbeelding-taak, of een met meerdere aanzichten.
- Ongeldig aantal afbeeldingen: image_urls of texture_image_urls bevat niet 1 tot 4 afbeeldingen.
- Ongeldig afbeeldingsformaat: Een afbeelding in image_urls heeft geen ondersteund formaat.
- Conflicterende texture-invoer: texture_image_urls is meegestuurd met texture_image_url, met texture_prompt, of met should_texture: false.
- Niet-ondersteund model voor texture met meerdere aanzichten: texture_image_urls is meegestuurd met ai_model van meshy-6 of meshy-6-lite, tenzij texture_model meshy-7 of meshy-n1 is.
- Onbereikbare URL: Meshy kan een afbeelding in image_urls of texture_image_urls niet downloaden.
- Afbeelding te groot: Een afbeelding in image_urls, texture_image_url, of texture_image_urls is groter dan 20 MB.
- Ongeldige afbeeldingsgrootte: Een afbeelding in image_urls, texture_image_url, of texture_image_urls heeft een zijde korter dan 32 pixels, of meer dan 178.956.970 pixels (breedte × hoogte).
- Niet-ondersteunde resolutie voor invoer met meerdere afbeeldingen: geometry_resolution is "4k", wat dit endpoint niet ondersteunt. Gebruik 2k of standard.
- Niet-ondersteund model voor afbeeldingsopties: image_enhancement is meegestuurd met ai_model: "meshy-6-lite", of remove_lighting is meegestuurd met ai_model: "meshy-6-lite" en het bijbehorende standaard texturemodel.
- Ongeldig texturemodel: texture_model is geen geldige texturemodelnaam.
- Texturemodel niet beschikbaar: Een getextureerd verzoek stuurde texture_model van meshy-6 of meshy-6-lite. Multi-afbeelding naar 3D accepteert alleen de texturemodellen die textureren vanuit meerdere aanzichten. Stuur meshy-7 of meshy-n1, of laat texture_model weg.
- Niet-ondersteunde optie voor het texturemodel: Het verzoek vraagt het texturemodel om een optie die het niet ondersteunt, zoals enable_pbr: true met meshy-n1 of een 4k-texture met meshy-6-lite. Zie Modellen.
Corrigeer het verzoek en stuur het opnieuw. Zie Fouten.
Name
401 - Unauthorized
Description
De API-sleutel ontbreekt of is ongeldig. Controleer de header Authorization.
Name
402 - Payment Required
Description
Bijvoorbeeld:
- Onvoldoende credits: Het account heeft niet genoeg credits voor deze taak, of het account heeft een creditlimiet bereikt. Controleer je creditsaldo en probeer het opnieuw.
- Gratis abonnement: Voor het maken van een taak is een betaald abonnement vereist. Upgrade je abonnement in je abonnementsinstellingen en probeer het opnieuw.
Name
403 - Forbidden
Description
Contentmoderatie heeft de prompt of een invoerafbeelding geblokkeerd. Wijzig de invoer en probeer het opnieuw.
Name
404 - Not Found
Description
input_task_id komt niet overeen met een van je taken. Controleer de taak-ID en stuur het verzoek opnieuw.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden. Wacht en probeer het opnieuw. Zie Rate limits.

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

Haal een Multi-afbeelding naar 3D-taak op

Retourneert een Multi-afbeelding naar 3D-taak op basis van de 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
}

Parameters

Name
id
Type
path
Description
De taak-ID uit de aanmaakreactie.

Retourwaarden

Het Multi-afbeelding naar 3D-taakobject.

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

Een Multi-afbeelding naar 3D-taak verwijderen

Verwijdert een Multi-afbeelding naar 3D-taak permanent, inclusief de bijbehorende modellen en gegevens. Je kunt een verwijdering niet ongedaan maken.

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

Padparameters

Name
id
Type
path
Description
De ID van de te verwijderen taak.

Taakstatus

Het verwijderen van een PENDING-taak restitueert de credits die zijn gebruikt bij het aanmaken ervan.

Een IN_PROGRESS-taak kan niet worden verwijderd. Het verzoek retourneert 409 Conflict, en de taak blijft actief. Meshy restitueert geen taak die al is gestart, dus het verwijderen ervan zou je zowel de credits als het resultaat kosten. Wacht tot deze de status SUCCEEDED, FAILED of CANCELED bereikt, en verwijder hem dan.

Het verwijderen van een taak met een definitieve status (SUCCEEDED, FAILED of CANCELED) restitueert de credits niet.

Retourwaarden

200 OK wanneer de taak is verwijderd, of 409 Conflict wanneer de taak IN_PROGRESS is.

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

Lijst van Multi-afbeelding naar 3D-taken

Geeft een lijst van uw Multi-afbeelding naar 3D-taken terug.

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

Parameters

Name
page_num
Type
integer
standaard 1
Description
Het paginanummer dat moet worden geretourneerd, tot 255. Een hogere waarde levert 400 op.
Name
page_size
Type
integer
standaard 10
Description
Het aantal taken per pagina, tot 100.
Name
sort_by
Type
string
Description
De sorteervolgorde.
Beschikbare waarden:
- +created_at: oudste eerst
- -created_at: nieuwste eerst

Retourwaarden

Een gepagineerde lijst van Multi-afbeelding naar 3D-taakobjecten.

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

Stream een Multi-afbeelding naar 3D taak

Streamt de updates van een Multi-afbeelding naar 3D taak als 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
}

Parameters

Name
id
Type
path
Description
De taak-ID uit de create-respons.

Retourwaarden

Een stream van Multi-afbeelding naar 3D taakobjecten als Server-Sent Events.

Elk event bevat het volledige taakobject, in dezelfde vorm als de Get-endpoint teruggeeft. Zolang de taak PENDING of IN_PROGRESS is, hebben de resultaatvelden nog geen waarden.

Het Multi-afbeelding naar 3D taakobject

Een Multi-afbeelding naar 3D taakobject beschrijft één generatie van een 3D-model op basis van één tot vier afbeeldingen van een object. Het bevat de status, de progress en de modelbestanden wanneer de taak slaagt.

Eigenschappen

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
De taak-ID. Behandel dit als een ondoorzichtige string en vertrouw niet op het formaat ervan.
Name
type
Type
string
Description
Het taaktype, altijd multi-image-to-3d.
Name
model_urls
Type
object
Description
Download-URL's voor het gegenereerde 3D-model, één per bestandsformaat. Een formaat dat de taak niet heeft gegenereerd, heeft geen sleutel, in plaats van een lege string.
- Name
  glb
  Type
  string
  Description
  Het GLB-bestand.
- Name
  fbx
  Type
  string
  Description
  Het FBX-bestand.
- Name
  obj
  Type
  string
  Description
  Het OBJ-bestand.
- Name
  usdz
  Type
  string
  Description
  Het USDZ-bestand.
- Name
  mtl
  Type
  string
  Description
  Het MTL-bestand, geretourneerd samen met het OBJ-bestand wanneer het model texturen heeft.
- Name
  stl
  Type
  string
  Description
  Het STL-bestand.
- Name
  3mf
  Type
  string
  Description
  Het 3MF-bestand. Alleen aanwezig wanneer target_formats 3mf bevat.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Het GLB-bestand van vóór de remesh. Alleen aanwezig wanneer je de taak hebt aangemaakt met zowel should_remesh: true als save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Download-URL voor een voorbeeldafbeelding van het model. Deze is identiek aan thumbnail_urls.front wanneer dat veld aanwezig is.
Name
alpha_thumbnail_url
Type
string
Description
Download-URL voor een versie van thumbnail_url met een transparante achtergrond (RGBA). Alleen aanwezig wanneer je de taak hebt aangemaakt met alpha_thumbnail: true en Meshy de transparante preview heeft gerenderd.
Name
thumbnail_urls
Type
object
Description
Download-URL's voor previews van het 3D-model vanuit vier kanten. Elk is een ondertekende URL naar een 512×512 PNG, gerenderd met dezelfde materialen en belichting als thumbnail_url. Je kunt ze gebruiken om het model vanuit meerdere hoeken te bekijken zonder de GLB te downloaden.
Alleen aanwezig wanneer je de taak hebt aangemaakt met multi_view_thumbnails: true en de taak de status SUCCEEDED heeft bereikt. Een taak die zonder multi_view_thumbnails: true is aangemaakt, heeft dit veld niet.
- Name
  front
  Type
  string
  Description
  Het vooraanzicht, op 0° rond de verticale as. Komt overeen met thumbnail_url.
- Name
  right
  Type
  string
  Description
  Het rechteraanzicht, op 90°.
- Name
  back
  Type
  string
  Description
  Het achteraanzicht, op 180°.
- Name
  left
  Type
  string
  Description
  Het linkeraanzicht, op 270°.
Name
texture_prompt
Type
string
Description
De tekst-prompt die de textuur heeft gestuurd.
Name
texture_image_urls
Type
string[]
Description
Download-URL's voor de textuurreferentieafbeeldingen waarmee je de taak hebt aangemaakt, in de volgorde waarin je ze hebt verzonden. Alleen aanwezig wanneer je de taak hebt aangemaakt met texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ verouderd
Description
Lees in plaats daarvan geometry_resolution.
Name
geometry_resolution
Type
string
Description
De Ultra-laag waarin de taak is uitgevoerd, namelijk 2k. Een standard-taak heeft dit veld niet.
Name
progress
Type
integer
Description
Hoeveel van de taak is voltooid, als percentage. Dit is 0 totdat de taak start en 100 wanneer deze slaagt.
Name
started_at
Type
timestamp
Description
Tijdstip waarop de taak is gestart, in Unix-milliseconden. Dit is 0 totdat de taak start.
Name
created_at
Type
timestamp
Description
Tijdstip waarop de taak is aangemaakt, in Unix-milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstip waarop de resultaten van de taak verlopen, in Unix-milliseconden.
Name
finished_at
Type
timestamp
Description
Tijdstip waarop de taak is voltooid, in Unix-milliseconden. Dit is 0 totdat de taak voltooid is.
Name
status
Type
string
Description
De taakstatus, een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED of CANCELED.
Name
texture_urls
Type
array
Description
Download-URL's voor de texture maps die de taak heeft gegenereerd, als een array van objecten. Deze bevat meestal één object. Elk object heeft de volgende velden:
- Name
  base_color
  Type
  string
  Description
  De base color map.
- Name
  metallic
  Type
  string
  Description
  De metallic map. Niet inbegrepen wanneer je de taak hebt aangemaakt met enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  De normal map. Niet inbegrepen wanneer je de taak hebt aangemaakt met enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  De roughness map. Niet inbegrepen wanneer je de taak hebt aangemaakt met enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  De emission map. Alleen inbegrepen wanneer je de taak hebt aangemaakt met al het volgende:
  
  ai_model: meshy-6, met het bijbehorende standaard textuurmodel
  
  enable_pbr: true
  
  een texture_resolution van 2k of 4k
Name
preceding_tasks
Type
integer
Description
Het aantal taken dat vóór deze taak in de wachtrij staat. De waarde is alleen relevant zolang de taak PENDING is.
Name
task_error
Type
object
Description
De foutdetails wanneer de taak mislukt. Dit is null tenzij de status FAILED is. Zie Fouten.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat de taak heeft gebruikt. Aanwezig wanneer de status PENDING, IN_PROGRESS of SUCCEEDED is. Dit is 0 voor een FAILED-taak, omdat Meshy de credits terugbetaalt wanneer een taak mislukt.