Zet een bronfoto om in een 3D-printbare sleutelhanger-medaille — een badgevormig
ingekleurd diepte-reliëf — in twee fasen: prototype genereert een ingekleurd
conceptbeeld op basis van je invoerfoto, waarna build dat conceptbeeld omzet
in een 3D-reliëfmodel. De twee fasen zijn gekoppeld via input_task_id.
Genereer één ingekleurde conceptafbeelding op basis van de bronfoto. De
geretourneerde taak-ID is wat je als input_task_id doorgeeft aan de build-
endpoint. Raadpleeg
Het sleutelhanger-prototypetaakobject
voor de structuur van de response.
Parameters
Name
image_url
Type
string
Verplicht
Description
Bronfoto die Meshy inkleurt tot een conceptafbeelding die klaar is voor een sleutelhanger. We ondersteunen momenteel de indelingen .jpg, .jpeg, .png en .webp.
Er zijn twee manieren om de afbeelding op te geven:
Publiek 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
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.
Retourneert
De eigenschap result van de response bevat de taak-id van de nieuw aangemaakte sleutelhanger-prototypetaak. Poll de endpoint Een taak ophalen of abonneer je op de stream totdat de taak SUCCEEDED bereikt, en geef die ID vervolgens door aan de build-endpoint als input_task_id.
Foutmodi
Name
400 - Bad Request
Description
De request was niet acceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: image_url is vereist.
Ongeldige afbeeldingsindeling: De opgegeven image_url heeft geen ondersteunde indeling (.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 onjuist gevormd.
Inhoud gemarkeerd: De invoerafbeelding is gemarkeerd door NSFW- of intellectueel-eigendoms-moderation.
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/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept imagecurl https://api.meshy.ai/openapi/creative-lab/keychain/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source photo, then generate the prototype image used by the keychain build stage.
Genereer het uiteindelijke 3D-printbare sleutelhanger-medaillon vanuit een geslaagde
prototypetaak. De build voert een depth-map-reliëfpijplijn uit op de
ingekleurde conceptafbeelding van het prototype en levert één mesh-artefact in
de indeling die je aanvraagt. Raadpleeg
Het Keychain Build Task-object voor de
vorm van de response.
Parameters
Name
input_task_id
Type
string
Verplicht
Description
De taak-ID van een prototypetaak die via dezelfde OpenAPI endpoint is gemaakt. Het prototype moet met dezelfde API-sleutel zijn gemaakt, moet SUCCEEDED hebben bereikt en moet precies één kandidaat-afbeelding hebben geproduceerd.
Prototypetaken die via de webapp zijn gemaakt, worden niet geaccepteerd — de build-endpoint accepteert alleen prototypetaken die zijn geproduceerd door POST /openapi/creative-lab/keychain/v1/prototype en weigert elke andere bron met 404.
Name
name
Type
string
Description
Optionele taaknaam voor weergavedoeleinden. Maximaal 100 tekens.
options
Optionele afstemmingsparameters voor de reliëfgeometrie. Elk veld heeft een verstandige standaardwaarde — verstuur alleen de velden die je wilt overschrijven.
Name
badge_shape
Type
string
standaard circle
Description
Omtreksilhouet van het sleutelhanger-medaillon. Beschikbare waarden:
circle (standaard)
rounded-rect
hexagon
shield
star
Name
size_mm
Type
number
standaard 40
Description
Randlengte van het begrenzende vierkant van de sleutelhanger, in millimeters. Bereik: (0, 400].
Name
relief_height_mm
Type
number
standaard 2.2
Description
Maximale reliëfhoogte boven de basis, in millimeters. Bereik: [0, 20].
Name
relief_offset_mm
Type
number
standaard 0
Description
Verticale offset die vóór extrusie op het reliëf wordt toegepast, in millimeters. Bereik: [0, 20].
Name
base_thickness_mm
Type
number
standaard 0.1
Description
Dikte van de vlakke basisplaat achter het reliëf, in millimeters. Bereik: [0, 20].
Name
has_closed_back
Type
boolean
standaard true
Description
Of de achterkant van het medaillon is afgedicht als een gesloten oppervlak. Stel in op false voor een open schaal.
Name
relief_curve
Type
string
standaard linear
Description
Overdrachtscurve die depth-mapwaarden omzet naar reliëfhoogte. Beschikbare waarden:
linear (standaard)
gamma
s-curve
Name
curve_param
Type
number
standaard 1.0
Description
Vormparameter voor de overdrachtscurve (alleen betekenisvol wanneer relief_curvegamma is). Bereik: (0, 10].
Name
invert_depth
Type
boolean
standaard false
Description
Keer de interpretatie van de depth map om zodat donkere gebieden een hoger reliëf worden.
Name
smoothing
Type
number
standaard 0.24
Description
Afvlakkingssterkte die op de depth map wordt toegepast vóór reliëfextractie. Bereik: [0, 10].
Name
relief_scale
Type
number
standaard 1.0
Description
Verticale schaalvermenigvuldiger die bovenop relief_height_mm wordt toegepast. Bereik: (0, 10].
Name
depth_threshold
Type
number
standaard 0.1
Description
Low-pass-drempel voor depth-mapwaarden; alles hieronder wordt op nul vastgezet. Bereik: [0, 1].
Name
remove_background
Type
boolean
standaard true
Description
Verwijder automatisch de achtergrond van de conceptafbeelding van het prototype vóór het aanbrengen van reliëf.
Name
export_resolution
Type
integer
standaard 512
Description
Mesh-resolutie die wordt gebruikt voor export. Bereik: [64, 2048].
output
Optionele selector voor de wire-format. Standaard ingesteld op glb.
Name
format
Type
string
standaard glb
Description
Artefactbundel die door de build wordt geretourneerd. Beschikbare waarden:
glb (standaard) — retourneert één 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 uitstuurt en retourneert de bundel onder model_urls.bundle_zip.
Retourneert
De eigenschap result van de response bevat de taak-id van de nieuw gemaakte sleutelhanger-buildtaak. Poll de Get a Task-endpoint of abonneer je op de stream totdat de taak SUCCEEDED bereikt, en download vervolgens het artefact vanuit de enkele vermelding in model_urls.
Foutmodi
Name
400 - Bad Request
Description
De aanvraag was onacceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: input_task_id is vereist.
Ongeldige UUID: De input_task_id is geen geldige UUID.
Bovenliggende taak niet geslaagd: De verwezen prototypetaak heeft SUCCEEDED nog niet bereikt.
Geen kandidaat: De prototypetaak is geslaagd maar heeft geen kandidaat-afbeelding geproduceerd.
Opties buiten bereik: Een van de options-velden viel buiten het toegestane bereik of de toegestane enum-set.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
404 - Not Found
Description
De verwezen prototypetaak bestaat niet, behoort toe aan een andere gebruiker of is via de webapp gemaakt (alleen prototypetaken in API-mode kunnen worden gekoppeld aan build).
Haal een prototype- of buildtaak op met een geldige taak-id. Het URL-pad
moet overeenkomen met de fase van de taak — een buildtaak die via
/prototype/:id wordt opgehaald, retourneert 404, en omgekeerd.
Annuleer een sleutelhanger-taak. Als de taak nog steeds PENDING is, worden de credits
die bij het aanmaken zijn verbruikt terugbetaald. Taken die al
IN_PROGRESS zijn, worden geannuleerd zonder terugbetaling (de worker kan al
bronnen verbruiken). 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 retourneert 404.
Padparameters
Name
id
Type
path
Description
Unieke identifier voor de sleutelhanger-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 ervan komt niet overeen met het URL-pad.
Stream realtime updates voor een sleutelhanger-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 verzendt één enkele event: error-payload met
status_code: 404 en sluit de stream.
Parameters
Name
id
Type
path
Description
Unieke identificatie voor de sleutelhanger-taak die moet worden gestreamd.
Retourneert
Retourneert een stream van taakobjecten voor sleutelhanger-prototype
of sleutelhanger-build als
Server-Sent Events. Voor PENDING- of IN_PROGRESS-taken bevat de response
stream alleen de noodzakelijke velden progress en status.
// Error event example (wrong stage or task not found)event: errordata: {"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: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-keychain-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***" }}
Haal een gepagineerde lijst op van je sleutelhanger-taken voor één fase. Het URL-
pad selecteert de fase — /prototype retourneert prototype-taken; /build
retourneert build-taken. Taken uit de andere fase worden in geen van beide
responses opgenomen.
Padparameters
Name
stage
Type
path
Verplicht
Description
Ofwel prototype of build. De collectie retourneert alleen taken
waarvan de fase overeenkomt met de URL — het ophalen van /prototype retourneert nooit
build-taken en omgekeerd.
Queryparameters
Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.
Name
page_size
Type
integer
standaard 10
Description
Limiet voor paginagrootte. Het maximaal toegestane aantal is 50 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.
Het sleutelhanger-prototypetaakobject is een werkeenheid die Meshy bijhoudt om
een ingekleurde conceptafbeelding te genereren op basis van een bronfoto. De uitvoer van
deze fase wordt via input_task_id gekoppeld aan de bouwfase.
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie 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 taak. De waarde is creative-lab-keychain-prototype.
Name
name
Type
string
Description
De taaknaam die is opgegeven toen de taak werd aangemaakt. 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 wanneer de taak is aangemaakt, in milliseconden.
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 geldt
voor alle tijdstempels in Meshy API.
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.
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
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
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. Retourneert 0 voor FAILED-taken (credits worden terugbetaald bij mislukking).
Name
image_urls
Type
array of strings
Description
Downloadbare URL's voor de conceptafbeeldingskandidaten die door deze prototypetaak zijn gegenereerd. Momenteel retourneert de API altijd exact één kandidaat; het veld is een array zodat toekomstige revisies meerdere kandidaten kunnen tonen zonder een breaking change.
Het sleutelhanger-bouwtaakobject is een werkeenheid die Meshy bijhoudt om
de uiteindelijke 3D-sleutelhanger-mesh te genereren op basis van een geslaagde prototypetaak. De
build voert een depth-map-reliëfpipeline uit op de conceptafbeelding van het prototype en
publiceert één mesh-artefact in de indeling die de aanroeper heeft aangevraagd.
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie voor de taak.
Name
type
Type
string
Description
Type van de taak. De waarde is creative-lab-keychain-build.
Name
name
Type
string
Description
De taaknaam die is opgegeven toen de taak werd aangemaakt. Lege tekenreeks 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
De 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 wanneer de taak is aangemaakt, in milliseconden.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gestart, in milliseconden.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken. Alleen betekenisvol wanneer de status 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. Retourneert 0 voor FAILED-taken (credits worden terugbetaald bij mislukking).
Name
model_urls
Type
object
Description
Downloadbare URL's voor het gegenereerde artefact, gesleuteld op artefactnaam. Bevat altijd exact één item — de indeling aangevraagd via de output.format van het buildverzoek. De sleutel komt overeen met de aangevraagde indeling:
Name
glb
Type
string
Description
Downloadbare URL naar het GLB-bestand. Aanwezig wanneer output.formatglb was (de standaardinstelling).
Name
obj
Type
string
Description
Downloadbare URL naar een zipbundel met model.obj, model.mtl en texture.png. Aanwezig wanneer output.formatobj was.
Name
bundle_zip
Type
string
Description
Downloadbare URL naar een zipbundel van elk artefact dat de generator uitvoert. Aanwezig wanneer output.formatzip was.