Creative Lab — koelkastmagneet-API

Verander je foto's in aangepaste koelkastmagneten — een gekleurd reliëf in een rechthoek met afgeronde hoeken en een platte magnetische achterkant, op maat gemaakt voor de koelkast — in twee fasen: prototype genereert een gekleurde conceptafbeelding op basis van je invoerfoto, waarna build die conceptafbeelding omzet in een 3D-model met reliëf. De twee fasen zijn gekoppeld via input_task_id.

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Een koelkastmagneet-prototypetaak aanmaken

Genereer één gekleurde conceptafbeelding op basis van de brontfoto. De geretourneerde task-ID is wat je als input_task_id doorgeeft aan de build- endpoint. Raadpleeg Het Fridge Magnet Prototype Task-object voor de vorm van de response.

Parameters

Name
image_url
Type
string
Verplicht
Description
Brontfoto die Meshy inkleurt tot een conceptafbeelding die klaar is voor een koelkastmagneet. We ondersteunen momenteel de formaten .jpg, .jpeg, .png en .webp.
Er zijn twee manieren om de afbeelding aan te leveren:
- Publiek toegankelijke URL: een URL die vanaf het openbare internet toegankelijk is.
- 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
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.
Name
remove_background
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de prototypeafbeelding geretourneerd als een transparante RGBA-PNG waarbij de achtergrond is verwijderd, zodat je het onderwerp op elke achtergrond kunt samenstellen.
Dit heeft alleen invloed op de afbeelding die deze endpoint retourneert. Het is los van de gelijknamige build-optie (standaard true), die het verwijderen van de achtergrond regelt vóórdat het reliëf wordt toegepast.

Retourwaarden

De eigenschap result van de response bevat het id van de nieuw aangemaakte koelkastmagneet-prototypetaak. Poll de endpoint Een taak ophalen of abonneer je op de stream totdat de taak de status SUCCEEDED bereikt, en geef vervolgens dat ID door als input_task_id aan de build-endpoint.

Faalmodi

Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
- Ontbrekende parameter: image_url is verplicht.
- Ongeldig afbeeldingsformaat: de opgegeven image_url heeft geen ondersteund formaat (.jpg, .jpeg, .png, .webp).
- Afbeeldingsafmetingen buiten bereik: de afbeelding is te klein, overschrijdt de maximale bestandsgrootte of overschrijdt het maximale aantal pixels.
- Onbereikbare URL: de image_url kon niet worden gedownload (404 of timeout).
- Ongeldige Data URI: de base64-string is misvormd.
- Content gemarkeerd: de inputafbeelding is gemarkeerd door moderation voor NSFW of intellectueel eigendom.
Name
401 - Unauthorized
Description
Authenticatie is 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/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype \
  -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>"
  }'

Response

{
  "result": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}

Prototype example

Start met een brontfoto en genereer vervolgens de prototypeafbeelding die door de koelkastmagneet-buildfase wordt gebruikt.

Brontfoto van een landschap gebruikt als input voor de Creative Lab Fridge Magnet — Prototype input

Prototype-output van de Creative Lab Fridge Magnet gegenereerd op basis van de brontfoto — Prototype output

POST/openapi/creative-lab/fridge-magnet/v1/build

Een koelkastmagneet-buildtaak aanmaken

Genereer de definitieve, 3D-printbare koelkastmagneet vanuit een geslaagde prototypetaak. De build voert een depth-map-reliëfpipeline uit op de gekleurde conceptafbeelding van het prototype en levert één mesh-artefact op in het door u opgegeven formaat. Raadpleeg Het Fridge Magnet Build Task Object voor de vorm van de response.

Parameters

Name
input_task_id
Type
string
Verplicht
Description
De task-ID van een prototypetaak die via dezelfde OpenAPI-endpoint is aangemaakt. Het prototype moet zijn aangemaakt met dezelfde API-sleutel, moet SUCCEEDED hebben bereikt, en moet precies één kandidaatafbeelding hebben opgeleverd.
Prototypetaken die via de webapp zijn aangemaakt worden niet geaccepteerd — de build-endpoint accepteert alleen prototypetaken die zijn geproduceerd door POST /openapi/creative-lab/fridge-magnet/v1/prototype en wijst elke andere bron af met 404.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.

`options`

Optionele afstelparameters voor de reliëfgeometrie. Elk veld heeft een zinvolle standaardwaarde — stuur alleen de velden die u wilt overschrijven.

Name
badge_shape
Type
string
standaard rounded-rect
Description
Omtreksilhouet van de koelkastmagneet. Beschikbare waarden:
- circle
- rounded-rect (standaard)
- hexagon
- shield
- star
Name
size_mm
Type
number
standaard 60
Description
Zijlengte van het omsluitende vierkant van de koelkastmagneet, in millimeter. Bereik: (0, 400].
Name
relief_height_mm
Type
number
standaard 3.3
Description
Maximale reliëfhoogte boven de basis, in millimeter. Bereik: [0, 20].
Name
relief_offset_mm
Type
number
standaard 0
Description
Verticale offset toegepast op het reliëf vóór extrusie, in millimeter. Bereik: [0, 20].
Name
base_thickness_mm
Type
number
standaard 2.0
Description
Dikte van de platte basisplaat achter het reliëf, in millimeter. De standaard voor de koelkastmagneet is een steviger basis van 2 mm — dit geeft de magneet voldoende body om aan de koelkast te blijven kleven zonder dat het reliëf breekbaar aanvoelt. Bereik: [0, 20].
Name
has_closed_back
Type
boolean
standaard true
Description
Of de achterkant van de koelkastmagneet is afgesloten als een gesloten oppervlak (de kant waar u de magneet op plakt). Zet op false voor een open shell.
Name
relief_curve
Type
string
standaard linear
Description
Overdrachtscurve die depth-map-waarden koppelt aan reliëfhoogte. Beschikbare waarden:
- linear (standaard)
- gamma
- s-curve
Name
curve_param
Type
number
standaard 1.0
Description
Vormparameter voor de overdrachtscurve (alleen relevant wanneer relief_curve gamma is). Bereik: (0, 10].
Name
invert_depth
Type
boolean
standaard false
Description
Keer de interpretatie van de depth-map om, zodat donkerdere gebieden een hoger reliëf krijgen.
Name
smoothing
Type
number
standaard 0.24
Description
Mate van afvlakking toegepast op de depth-map vóór reliëfextractie. Bereik: [0, 10].
Name
relief_scale
Type
number
standaard 1.0
Description
Verticale schaalvermenigvuldiger toegepast bovenop relief_height_mm. Bereik: (0, 10].
Name
depth_threshold
Type
number
standaard 0.1
Description
Low-pass-drempelwaarde voor depth-map-waarden; alles hieronder wordt vastgezet op nul. Bereik: [0, 1].
Name
remove_background
Type
boolean
standaard true
Description
Verwijder automatisch de achtergrond van de conceptafbeelding van het prototype vóór het reliëfproces.
Los van de gelijknamige prototypeparameter (standaard false), die bepaalt of de prototypeafbeelding zelf met transparantie wordt geretourneerd.
Name
export_resolution
Type
integer
standaard 512
Description
Mesh-resolutie gebruikt voor export. Bereik: [64, 2048].

`output`

Optionele selector voor het bestandsformaat. Standaard glb.

Name
format
Type
string
standaard glb
Description
Artefactbundel die door de build wordt geretourneerd. Beschikbare waarden:
- glb (standaard) — retourneert een enkele model.glb onder model_urls.glb.
- obj — zipt model.obj + model.mtl + texture.png en retourneert de bundel onder model_urls.obj.
- zip — zipt elk artefact dat de generator produceert en retourneert de bundel onder model_urls.bundle_zip.

Retourneert

De result-eigenschap van de response bevat de task-id van de nieuw aangemaakte koelkastmagneet-buildtaak. Poll de Get a Task-endpoint of abonneer u op de stream totdat de taak SUCCEEDED bereikt, en download vervolgens het artefact uit het enige item in model_urls.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
- Ontbrekende parameter: input_task_id is verplicht.
- Ongeldige UUID: De input_task_id is geen geldige UUID.
- Bovenliggende taak niet geslaagd: De aangewezen prototypetaak heeft SUCCEEDED nog niet bereikt.
- Geen kandidaat: De prototypetaak is geslaagd, maar heeft geen kandidaatafbeelding opgeleverd.
- Options buiten bereik: Een van de options-velden viel buiten het toegestane bereik of de toegestane enum-set.
Name
401 - Unauthorized
Description
Authenticatie is mislukt. Controleer uw API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
404 - Not Found
Description
De aangewezen prototypetaak bestaat niet, behoort toe aan een andere gebruiker, of is aangemaakt via de webapp (alleen prototypetaken in API-mode kunnen worden gekoppeld aan build).
Name
429 - Too Many Requests
Description
U heeft uw rate limit overschreden.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

De buildtaak zet de geselecteerde prototypeafbeelding om in een 3D-printbaar koelkastmagneetmodel.

Creative Lab Fridge Magnet build model preview — Build model preview

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Een koelkastmagneet-taak ophalen

Haal een prototype- of build-taak op met een geldige taak-id. Het URL-pad moet overeenkomen met de fase van de taak — een build-taak die via /prototype/:id wordt opgehaald, retourneert 404, en omgekeerd.

Raadpleeg Het Fridge Magnet Prototype Task-object en Het Fridge Magnet Build Task-object voor de vorm van de respons.

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de op te halen koelkastmagneet-taak.

Retourwaarden

De respons bevat het koelkastmagneet-taakobject. De vorm hangt af van welke fase is opgevraagd.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Verwijder een koelkastmagneet-taak

Annuleer een koelkastmagneet-taak. Als de taak nog PENDING is, worden de credits die bij het aanmaken zijn verbruikt, terugbetaald. Taken die al IN_PROGRESS zijn, worden geannuleerd zonder terugbetaling (de worker verbruikt mogelijk al Bronnen). Taken die al een eindstatus hebben bereikt (SUCCEEDED, FAILED, CANCELED) kunnen niet worden geannuleerd.

Het URL-pad moet overeenkomen met de fase van de taak — DELETE op /prototype/:buildId geeft 404 terug.

Padparameters

Name
id
Type
path
Description
Unieke identificatie voor de koelkastmagneet-taak die moet worden geannuleerd.

Retourneert

Retourneert 204 No Content bij succes met een lege body.

Foutmodi

Name
400 - Bad Request
Description
De taak bevindt zich al in een eindstatus en kan niet worden geannuleerd.
Name
404 - Not Found
Description
De taak bestaat niet, behoort toe aan een andere gebruiker, of de fase komt niet overeen met het URL-pad.

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Streamen van een koelkastmagneet-taak

Stream realtime updates voor een koelkastmagneet-taak via Server-Sent Events (SSE). Het URL-pad moet overeenkomen met de fase van de taak — het openen van een stream op /prototype/:buildId/stream geeft een enkele event: error payload terug met status_code: 404 en sluit de stream.

Parameters

Name
id
Type
path
Description
Unieke identifier voor de koelkastmagneet-taak om te streamen.

Retourneert

Retourneert een stream van Fridge Magnet Prototype of Fridge Magnet Build taakobjecten als Server-Sent Events. Elk frame draagt het volledige taakobject voor de fase — dezelfde vorm die de Get-endpoint retourneert — dus terwijl de taak PENDING of IN_PROGRESS is, zijn de outputvelden gewoon nog niet ingevuld (null, [] of {}) en is finished_at null.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Fridge Magnet-taken weergeven

Haal een gepagineerde lijst op van uw koelkastmagneet-taken voor één fase. Het URL-pad bepaalt de fase — /prototype geeft prototype-taken terug; /build geeft build-taken terug. Taken van de andere fase worden niet opgenomen in beide antwoorden.

Padparameters

Name
stage
Type
path
Verplicht
Description
Ofwel prototype of build. De collectie geeft alleen taken terug waarvan de fase overeenkomt met de URL — het ophalen van /prototype geeft nooit build-taken terug en vice versa.

Queryparameters

Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.
Name
page_size
Type
integer
standaard 10
Description
Paginagroottelimiet. Maximaal toegestaan is 100 items.
Name
sort_by
Type
string
standaard -created_at
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 van het taakobject per fase — ofwel het fridge magnet prototype-taakobject wanneer /prototype wordt weergegeven of het fridge magnet build-taakobject wanneer /build wordt weergegeven.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Het taakobject van het Fridge Magnet-prototype

Het taakobject van het Fridge Magnet-prototype is een werkeenheid die Meshy bijhoudt om een gekleurde conceptafbeelding te genereren op basis van een bronfoto. De output van deze fase wordt doorgeschakeld naar de buildfase via input_task_id.

Eigenschappen

Name
id
Type
string
Description
Unieke identificatie voor de taak. Hoewel we als implementatiedetail een k-sorteerbare UUID gebruiken voor taak-ID's, mag je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
De taaknaam die is opgegeven bij het aanmaken van de taak. Lege string als er geen naam is opgegeven.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Voortgang (progress) van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.
Name
created_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is aangemaakt, in milliseconden.
Een tijdstempel geeft het aantal milliseconden weer dat is verstreken sinds 1 januari 1970 UTC, volgens de RFC 3339-standaard. Vrijdag 1 september 2023 12:00:00 PM GMT wordt bijvoorbeeld weergegeven als 1693569600000. Dit geldt voor alle tijdstempels in de Meshy API.
Name
started_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is gestart, in milliseconden. Als de taak nog niet is gestart, is deze eigenschap 0.
Name
finished_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, is deze eigenschap 0.
Name
expires_at
Type
timestamp
Description
Tijdstempel van het moment waarop het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
De waarde van dit veld is alleen relevant als de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.
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 terugbetaald bij mislukking).
Name
image_urls
Type
array of strings
Description
Downloadbare URL's voor de conceptafbeelding-kandidaten die door deze prototypetaak zijn gegenereerd. Momenteel geeft de API altijd precies één kandidaat terug; het veld is een array zodat toekomstige revisies meerdere kandidaten kunnen tonen zonder een breaking change.

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Het Fridge Magnet Build Task-object

Het Fridge Magnet Build Task-object is een werkeenheid die Meshy bijhoudt om de uiteindelijke 3D-koelkastmagneet-mesh te genereren op basis van een geslaagde prototype-taak. De build voert een depth-map-reliëfpijplijn uit op de conceptafbeelding van het prototype en publiceert één mesh-artefact in het formaat dat de aanroeper heeft opgegeven.

Eigenschappen

Name
id
Type
string
Description
Unieke identifier voor de taak.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
De taaknaam die is opgegeven bij het aanmaken van de taak. Lege string als er geen naam is opgegeven.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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
created_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is aangemaakt, in milliseconden.
Name
started_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is gestart, in milliseconden.
Name
finished_at
Type
timestamp
Description
Tijdstempel van het moment waarop de taak is afgerond, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van het moment waarop het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken. Alleen relevant wanneer de status PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze taak is verbruikt. Geeft 0 terug voor FAILED-taken (credits worden terugbetaald bij een mislukking).
Name
model_urls
Type
object
Description
Downloadbare URL's voor het gegenereerde artefact, gesleuteld op artefactnaam. Bevat altijd precies één item — het formaat dat is opgegeven via output.format van het build-verzoek. De sleutel komt overeen met het opgevraagde formaat:
- Name
  glb
  Type
  string
  Description
  Downloadbare URL naar het GLB-bestand. Aanwezig wanneer output.format glb was (de standaardwaarde).
- Name
  obj
  Type
  string
  Description
  Downloadbare URL naar een zip-bundel met model.obj, model.mtl en texture.png. Aanwezig wanneer output.format obj was.
- Name
  bundle_zip
  Type
  string
  Description
  Downloadbare URL naar een zip-bundel van elk artefact dat de generator produceert. Aanwezig wanneer output.format zip was.

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}