Afbeelding naar 3D-API

Afbeelding naar 3D-API is een functie waarmee je Meshy's mogelijkheden voor Afbeelding naar 3D in je eigen applicatie kunt integreren. In deze sectie vind je alle informatie die je nodig hebt om met deze API aan de slag te gaan.

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

Een Afbeelding naar 3D-taak maken

Met deze endpoint kun je een nieuwe Afbeelding naar 3D-taak maken. Raadpleeg Het Afbeelding naar 3D-taakobject om te zien welke eigenschappen zijn opgenomen in het Afbeelding naar 3D-taakobject.

Parameters

Slechts één van input_task_id of image_url is vereist. Als beide worden opgegeven, krijgt input_task_id prioriteit.

Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide afbeeldingsgeneratietaak waarvan de uitvoer als invoerafbeelding moet worden gebruikt. Deze taak moet een van de volgende taken zijn: Tekst naar afbeelding of Afbeelding naar afbeelding. Daarnaast moet deze via de API zijn uitgevoerd, de status SUCCEEDED hebben en precies één afbeelding produceren.

Name
image_url
Type
string
Verplicht
Description
Geef een afbeelding op die Meshy kan gebruiken bij het maken van het model. We ondersteunen momenteel de formaten .jpg, .jpeg en .png.
Er zijn twee manieren om de afbeelding op te geven:
- Openbaar toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet.
- Data URI: Een base64-gecodeerde Data URI van de afbeelding. Voorbeeld van een Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
standaard standard
Description
Specificeer het type 3D Mesh-generatie.
Beschikbare waarden:
- standard: Reguliere 3D Mesh-generatie met hoog detailniveau.
- lowpoly: Genereert een low-poly mesh geoptimaliseerd voor schonere polygonen.
Wanneer lowpoly is geselecteerd, worden ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model genegeerd.
Name
ai_model
Type
string
standaard latest
Description
ID van het te gebruiken model. Beschikbare waarden: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
standaard true
Description
Bepaalt of texturen worden gegenereerd. Als dit op false wordt gezet, wordt de textuurfase overgeslagen en wordt een mesh zonder texturen geleverd.

Alleen van toepassing wanneer should_texture = true

Name
enable_pbr
Type
boolean
standaard false
Description
Genereer PBR-maps (metallic, roughness, normal) naast de basiskleur. Een emission map wordt ook opgenomen wanneer ai_model meshy-6 of latest is.
Name
hd_texture
Type
boolean
standaard false
Description
Genereer de basiskleurtextuur met 4K-resolutie (4096×4096) voor meer detail.
Alleen ondersteund wanneer ai_model meshy-6 of latest is. PBR-maps worden altijd op 2K gegenereerd.
Name
texture_prompt
Type
string
Description
Geef een tekstprompt op om het textureringsproces te sturen. Maximaal 600 tekens.
Name
texture_image_url
Type
string
Description
Geef een 2D-afbeelding op om het textureringsproces te sturen. We ondersteunen momenteel de formaten .jpg, .jpeg en .png.
Er zijn twee manieren om de afbeelding op te geven:
- Openbaar toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet
- Data URI: Een base64-gecodeerde Data URI van de afbeelding. Voorbeeld van een Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Afbeeldingstexturering werkt mogelijk niet optimaal als er aanzienlijke geometrieverschillen zijn tussen de oorspronkelijke asset en de geüploade afbeelding. Slechts één van texture_image_url of texture_prompt mag worden gebruikt om het textureringsproces te sturen. Als beide parameters worden opgegeven, wordt texture_prompt standaard gebruikt om het model te textureren. Texturering via tekst of afbeelding kost 10 credits per taak.

Name
should_remesh
Type
boolean
standaard false (meshy-6), true (others)
Description
Bepaalt of de Remesh-fase wordt ingeschakeld. Wanneer dit op false staat, retourneert de API de driehoekige mesh met de hoogste precisie.

Alleen van toepassing wanneer should_remesh = true

Name
topology
Type
string
standaard triangle
Description
Specificeer de topology van het gegenereerde model.
Beschikbare waarden:
- quad: Genereer een quad-dominante mesh.
- triangle: Genereer een gedecimeerde driehoeksmesh.
Name
target_polycount
Type
integer
standaard 30,000
Description
Specificeer het doel-aantal polygonen in het gegenereerde model. Het werkelijke aantal polygonen kan afwijken van het doel, afhankelijk van de complexiteit van de geometrie.
Het geldige waardebereik varieert afhankelijk van het gebruikersniveau:
- 100 tot 300.000 (inclusief)
Name
decimation_mode
Type
integer
Description
Schakel adaptieve decimatie in door een polygonaantalniveau in te stellen. Wanneer ingesteld, wordt target_polycount genegeerd.
Beschikbare waarden:
- 1: Adaptief — ultrahoog polygonaantal.
- 2: Adaptief — hoog polygonaantal.
- 3: Adaptief — gemiddeld polygonaantal.
- 4: Adaptief — laag polygonaantal.
Name
save_pre_remeshed_model
Type
boolean
standaard false
Description
Wanneer dit op true staat, slaat Meshy ook een extra GLB-bestand op voordat de Remesh-fase is voltooid.

Name
symmetry_mode
Type
string
⚠ verouderd
standaard auto
Description
Verouderd (deprecated). Deze parameter heeft geen invloed meer op de uitvoer.
Het veld symmetry_mode bepaalt het symmetriegedrag tijdens het modelgeneratieproces.
De geldige waarden zijn:
- off: Schakelt symmetrie uit.
- auto: Bepaalt en past automatisch symmetrie toe op basis van de invoergeometrie.
- on: Dwingt symmetrie af tijdens de generatie.
Name
pose_mode
Type
string
standaard ""
Description
Specificeer de pose_mode voor het gegenereerde model.
Beschikbare waarden:
- a-pose: Genereer het model in een A-pose.
- t-pose: Genereer het model in een T-pose.
- "" (lege tekenreeks): Geen specifieke pose toegepast.
Name
is_a_t_pose
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan pose_mode. Of het model in een A/T-pose moet worden gegenereerd.
Name
image_enhancement
Type
boolean
standaard true
Description
Optimaliseert de invoerafbeelding voor betere resultaten. Zet dit op false om het exacte uiterlijk van de invoerafbeelding te behouden zonder enige stijlverwerking.
Alleen ondersteund wanneer ai_model meshy-6 of latest is.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert highlights en schaduwen uit de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt onder aangepaste belichtingsopstellingen.
Alleen ondersteund wanneer ai_model meshy-6 of latest is.
Name
moderation
Type
boolean
standaard false
Description
Wanneer dit op true staat, wordt de invoerinhoud automatisch gescreend op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet door naar generatie.
De inhoud van de invoeren image_url, texture_image_url en texture_prompt wordt gescreend.
Name
target_formats
Type
string[]
Description
Specificeert welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de voltooiingstijd van de taak kan verkorten. Wanneer weggelaten, worden alle ondersteunde formaten opgenomen.
Beschikbare waarden: glb, obj, fbx, stl, usdz, 3mf
Wanneer weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer dit expliciet is gespecificeerd.
Name
auto_size
Type
boolean
standaard false
Description
Wanneer dit op true staat, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het formaat van het model dienovereenkomstig te wijzigen. De oorsprong wordt standaard bottom, tenzij origin_at expliciet is ingesteld.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer dit op true staat, rendert de taak daarnaast een versie met transparante achtergrond (RGBA) van de preview en retourneert deze als alpha_thumbnail_url in de GET-respons. Het bestaande veld thumbnail_url blijft ongewijzigd.
Name
multi_view_thumbnails
Type
boolean
standaard false
Description
Wanneer dit op true staat, rendert de taak daarnaast vier thumbnails vanuit kardinale aanzichten (voor, rechts, achter, links) en retourneert deze onder thumbnail_urls in de GET-respons. Het bestaande veld thumbnail_url blijft ongewijzigd en blijft naar het vooraanzicht wijzen, zodat bestaande clients niet worden beïnvloed.
Voegt ongeveer 3 seconden toe aan de taaklatentie.

Alleen van toepassing wanneer auto_size = true

Name
origin_at
Type
string
standaard bottom
Description
Positie van de oorsprong wanneer auto_size is ingeschakeld.
Beschikbare waarden: bottom, center.

Retourneert

De eigenschap result van de respons bevat de taak-id van de nieuw gemaakte Afbeelding naar 3D-taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
- Ontbrekende parameter: image_url of input_task_id moet worden opgegeven.
- Ongeldige invoertaak: De input_task_id moet verwijzen naar een SUCCEEDED Tekst naar afbeelding- of Afbeelding naar afbeelding-taak die precies één afbeelding produceert.
- Ongeldig afbeeldingsformaat: De opgegeven image_url heeft geen ondersteund formaat (.jpg, .jpeg, .png).
- Onbereikbare URL: De image_url kon niet worden gedownload (404 of timeout).
- Ongeldige Data URI: De base64-tekenreeks is misvormd.
- Ongeldige parametercombinatie: enable_pbr wordt alleen ondersteund wanneer should_texture true is.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.

Request

POST

/openapi/v1/image-to-3d

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

# With remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

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

Een Afbeelding naar 3D-taak ophalen

Deze endpoint stelt je in staat om een Afbeelding naar 3D-taak op te halen met een geldige taak-id. Raadpleeg Het Afbeelding naar 3D-taakobject om te zien welke eigenschappen zijn opgenomen in het Afbeelding naar 3D-taakobject.

Parameters

Name
id
Type
path
Description
Unieke identifier voor de Afbeelding naar 3D-taak die moet worden opgehaald.

Retourneert

De response bevat het Afbeelding naar 3D-taakobject. Bekijk de sectie Het Afbeelding naar 3D-taakobject voor details.

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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/image-to-3d/:id

Een Afbeelding naar 3D-taak verwijderen

Deze endpoint verwijdert permanent een Afbeelding naar 3D-taak, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Padparameters

Name
id
Type
path
Description
De ID van de Afbeelding naar 3D-taak die moet worden verwijderd.

Retourneert

Retourneert 200 OK bij succes.

Request

DELETE

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

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

Response

// Returns 200 Ok on success.

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

Afbeelding naar 3D-taken weergeven

Met dit endpoint kun je een lijst met Afbeelding naar 3D-taken ophalen.

Parameters

Optionele attributen

Name
page_num
Type
integer
Description
Paginanummer voor paginering. Begint bij en is standaard 1.
Name
page_size
Type
integer
Description
Limiet voor paginagrootte. Standaard 10 items. Het maximaal toegestane aantal is 50 items.
Name
sort_by
Type
string
Description
Veld om op te sorteren. Beschikbare waarden:
- +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
- -created_at: Sorteer op aanmaaktijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst met De Afbeelding naar 3D-taakobjecten.

Request

GET

/openapi/v1/image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "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/image-to-3d/:id/stream

Een Afbeelding naar 3D-taak streamen

Deze endpoint streamt realtime-updates voor een Afbeelding naar 3D-taak met Server-Sent Events (SSE).

Parameters

Name
id
Type
path
Description
Unieke identifier voor de Afbeelding naar 3D-taak die moet worden gestreamd.

Retourneert

Retourneert een stream van De Afbeelding naar 3D-taakobjecten als Server-Sent Events.

Voor PENDING- of IN_PROGRESS-taken bevat de responsstream alleen de noodzakelijke velden progress en status.

Request

GET

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

curl -N https://api.meshy.ai/openapi/v1/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": "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
}

Het Afbeelding naar 3D-taakobject

Het Afbeelding naar 3D-taakobject is een werkeenheid die Meshy bijhoudt om een 3D-model te genereren op basis van een afbeelding als invoer. Het object heeft de volgende eigenschappen:

Eigenschappen

Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we een k-sorteerbare UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de Afbeelding naar 3D-taak. De waarde is image-to-3d.
Name
model_urls
Type
object
Description
Downloadbare URL naar het getextureerde 3D-modelbestand dat door Meshy is gegenereerd. De eigenschap voor een indeling wordt weggelaten als de indeling niet is gegenereerd, in plaats van een lege string terug te geven.
- Name
  glb
  Type
  string
  Description
  Downloadbare URL naar het GLB-bestand.
- Name
  fbx
  Type
  string
  Description
  Downloadbare URL naar het FBX-bestand.
- Name
  obj
  Type
  string
  Description
  Downloadbare URL naar het OBJ-bestand.
- Name
  usdz
  Type
  string
  Description
  Downloadbare URL naar het USDZ-bestand.
- Name
  mtl
  Type
  string
  Description
  Downloadbare URL naar het MTL-bestand, samen met OBJ-exports teruggegeven wanneer texturen aanwezig zijn.
- Name
  stl
  Type
  string
  Description
  Downloadbare URL naar het STL-bestand.
- Name
  3mf
  Type
  string
  Description
  Downloadbare URL naar het 3MF-bestand. Alleen aanwezig wanneer 3mf is aangevraagd via target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadbare URL naar de oorspronkelijke GLB-uitvoer vóór remeshing.
  Alleen beschikbaar wanneer de taak is gemaakt met zowel should_remesh: true als save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Downloadbare URL naar de thumbnailafbeelding van het modelbestand. Komt overeen met thumbnail_urls.front wanneer aanwezig, behouden voor achterwaartse compatibiliteit.
Name
alpha_thumbnail_url
Type
string
Description
Downloadbare URL naar een versie met transparante achtergrond (RGBA) van thumbnail_url. Alleen aanwezig wanneer de taak is gemaakt met alpha_thumbnail: true en de transparante preview succesvol is gerenderd; anders wordt dit veld weggelaten.
Name
thumbnail_urls
Type
object
Description
Downloadbare URL's voor thumbnails van het gegenereerde 3D-model vanuit vier hoofdweergaven. Elke waarde is een ondertekende URL naar een 512×512 PNG, gerenderd met dezelfde materialen en belichting als thumbnail_url. Handig om het model vanuit meerdere hoeken te bekijken in batch-pipelines zonder de GLB te downloaden.
Alleen aanwezig wanneer de taak is gemaakt met multi_view_thumbnails: true en SUCCEEDED heeft bereikt. Oudere taken en taken die zonder de opt-in zijn gemaakt, bevatten dit veld niet.
- Name
  front
  Type
  string
  Description
  Vooraanzicht, 0° rotatie rond de verticale as (komt overeen met thumbnail_url).
- Name
  right
  Type
  string
  Description
  Rechteraanzicht, 90° rotatie.
- Name
  back
  Type
  string
  Description
  Achteraanzicht, 180° rotatie.
- Name
  left
  Type
  string
  Description
  Linkeraanzicht, 270° rotatie.
Name
texture_prompt
Type
string
Description
De tekstprompt die is gebruikt om het textureproces te sturen.
Name
texture_image_url
Type
string
Description
Downloadbare URL naar de textuurafbeelding die is gebruikt om het textureproces te sturen.
Name
progress
Type
integer
Description
Progress van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gestart, in milliseconden. Als de taak nog niet is gestart, is deze eigenschap 0.
Een tijdstempel vertegenwoordigt het aantal milliseconden dat is verstreken sinds 1 januari 1970 UTC, volgens de RFC 3339-standaard. Bijvoorbeeld: vrijdag 1 september 2023 12:00:00 PM GMT wordt weergegeven als 1693569600000. Dit is van toepassing op alle tijdstempels in Meshy API.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gemaakt, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, is deze eigenschap 0.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Een array van textuur-URL-objecten die vanuit de taak worden gegenereerd. Normaal gesproken bevat dit slechts één textuur-URL-object. Elke textuur-URL heeft de volgende eigenschappen:
- Name
  base_color
  Type
  string
  Description
  Downloadbare URL naar de base color map-afbeelding.
- Name
  metallic
  Type
  string
  Description
  Downloadbare URL naar de metallic map-afbeelding.
  Als de taak is gemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  normal
  Type
  string
  Description
  Downloadbare URL naar de normal map-afbeelding.
  Als de taak is gemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  roughness
  Type
  string
  Description
  Downloadbare URL naar de roughness map-afbeelding.
  Als de taak is gemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  emission
  Type
  string
  Description
  Downloadbare URL naar de emission map-afbeelding.
  Als de taak is gemaakt met enable_pbr: false, of ai_model is meshy-5, wordt deze eigenschap weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
De waarde van dit veld is alleen betekenisvol als de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige task_error-objectreferentie.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze taak is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS of SUCCEEDED is. Geeft 0 terug voor FAILED-taken (credits worden bij mislukking terugbetaald).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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": "",
  "texture_image_url": "",
  "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
}