Omvandla ett källfoto till en samlarfigur i vinyl med stort huvud i 3D i två
steg: prototype genererar en stiliserad konceptbild utifrån ditt inmatade
foto, och build omvandlar sedan den konceptbilden till en 3D-modell med texturer.
De två stegen länkas samman via input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Genererar en enda konceptbild i vinylfigurstil från källfotot. Det returnerade task-ID:t är det du skickar som input_task_id till build-endpointen. Se
The Vinyl Figure Prototype Task Object
för svarets format.
Parametrar
Name
image_url
Type
string
Obligatorisk
Description
Källfoto som Meshy ska stilisera som en big-head vinylfigur. Vi stöder för närvarande formaten .jpg, .jpeg, .png och .webp.
Det finns två sätt att ange bilden på:
Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga internet.
Data URI: En base64-kodad data-URI för bilden. Exempel på en data-URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Valfritt tasknamn för visningsändamål. Max 100 tecken.
Name
remove_background
Type
boolean
standard false
Description
När den sätts till true returneras prototypbilden som en transparent RGBA-PNG med bakgrunden borttagen, så att du kan sammanfoga motivet med valfri bakgrund.
Returer
Egenskapen result i svaret innehåller task-id:t för den nyskapade vinylfigur-prototyptasken. Fråga Get a Task-endpointen eller prenumerera på strömmen tills tasken når SUCCEEDED, och skicka sedan det ID:t till build-endpointen som input_task_id.
Felfall
Name
400 - Bad Request
Description
Förfrågan var oacceptabel. Vanliga orsaker:
Saknad parameter: image_url krävs.
Ogiltigt bildformat: Den angivna image_url har inte ett format som stöds (.jpg, .jpeg, .png, .webp).
Bildmått utanför tillåtet intervall: Bilden är för liten, överskrider den maximala filstorleken eller överskrider det maximala antalet pixlar.
Onåbar URL: image_url kunde inte laddas ner (404 eller timeout).
Ogiltig Data URI: Base64-strängen är felformaterad.
Innehåll flaggat: Den inmatade bilden flaggades av moderation för olämpligt innehåll eller immateriella rättigheter.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna task.
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \-XPOST \-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":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototypexempel
Börja med ett källfoto och generera sedan prototypbilden som används av build-steget.
Generera den slutliga texturerade 3D-vinylfiguren från en lyckad prototypåtgärd. Byggprocessen körs genom samma bild-till-3D-pipeline som
Bild till 3D, så svarsobjektets format och listan över utdata-URL:er stämmer exakt överens. Se
Objektet för vinylfigurens byggåtgärd
för svarets format.
Parametrar
Name
input_task_id
Type
string
Obligatorisk
Description
Aktivitets-ID för en prototypåtgärd som skapats via samma OpenAPI-endpoint. Prototypen måste ha skapats med samma API-nyckel, måste ha nått SUCCEEDED, och måste ha producerat exakt en kandidatbild.
Prototypåtgärder som skapats via webbappen accepteras inte — build-endpointen accepterar endast prototypåtgärder som producerats av POST /openapi/creative-lab/vinyl-figure/v1/prototype och avvisar alla andra källor med 404.
Name
name
Type
string
Description
Valfritt aktivitetsnamn för visningsändamål. Maximalt 100 tecken.
Returnerar
Egenskapen result i svaret innehåller aktivitets-id för den nyskapade byggåtgärden för vinylfiguren. Fråga Hämta en åtgärd-endpointen eller prenumerera på strömmen tills åtgärden når SUCCEEDED, och ladda sedan ner den texturerade GLB-filen från model_urls.glb (eller OBJ + MTL-paret från model_urls.obj och model_urls.mtl om din efterföljande pipeline föredrar OBJ).
Felmodes
Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
Saknad parameter: input_task_id krävs.
Ogiltig UUID: input_task_id är inte ett giltigt UUID.
Överordnad åtgärd ej lyckad: Den refererade prototypåtgärden har inte nått SUCCEEDED ännu.
Ingen kandidat: Prototypåtgärden lyckades men producerade ingen kandidatbild.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna åtgärd.
Name
404 - Not Found
Description
Den refererade prototypåtgärden finns inte, tillhör en annan användare, eller skapades via webbappen (endast prototypåtgärder i API-mode kan kedjas vidare till build).
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Hämta en prototyp- eller byggnadsuppgift givet ett giltigt id för uppgiften. URL-sökvägen
måste matcha uppgiftens steg — en byggnadsuppgift som hämtas via
/prototype/:id returnerar 404, och vice versa.
Avbryt en vinyl figure-uppgift. Om uppgiften fortfarande är PENDING
återbetalas de credits som förbrukades vid skapandet. Uppgifter som redan är
IN_PROGRESS avbryts utan återbetalning (arbetaren kan redan hålla på att
förbruka resurser). Uppgifter som redan har nått ett sluttillstånd
(SUCCEEDED, FAILED, CANCELED) kan inte avbrytas.
URL-sökvägen måste matcha uppgiftens steg — DELETE på
/prototype/:buildId returnerar 404.
Sökvägsparametrar
Name
id
Type
path
Description
Unik identifierare för den vinyl figure-uppgift som ska avbrytas.
Returer
Returnerar 204 No Content vid framgång med en tom body.
Felscenarier
Name
400 - Bad Request
Description
Uppgiften befinner sig redan i ett sluttillstånd och kan inte avbrytas.
Name
404 - Not Found
Description
Uppgiften finns inte, tillhör en annan användare, eller dess steg matchar inte URL-sökvägen.
Strömma realtidsuppdateringar för en vinylfigur-uppgift via Server-Sent Events
(SSE). URL-sökvägen måste matcha uppgiftens stadie — att öppna en ström vid
/prototype/:buildId/stream skickar en enda event: error-payload med
status_code: 404 och stänger strömmen.
Parametrar
Name
id
Type
path
Description
Unik identifierare för vinylfigur-uppgiften som ska strömmas.
Returer
Returnerar en ström av Vinyl Figure Prototype
eller Vinyl Figure Build uppgiftsobjekt
som Server-Sent Events. Varje bildruta innehåller hela uppgiftsobjektet för stadiet — samma form som
Get-endpointen returnerar — så medan uppgiften är PENDING eller IN_PROGRESS är
utdatafälten helt enkelt inte ifyllda ännu (null, [] eller {}) och
finished_at är null.
Hämta en paginerad lista över dina vinylfigur-uppgifter för ett enskilt steg.
URL-sökvägen väljer steget — /prototype returnerar prototyp-uppgifter;
/build returnerar build-uppgifter. Uppgifter från det andra steget ingår
inte i något av svaren.
Sökvägsparametrar
Name
stage
Type
path
Obligatorisk
Description
Antingen prototype eller build. Samlingen returnerar endast uppgifter
vars steg matchar URL:en — att hämta /prototype returnerar aldrig
build-uppgifter och vice versa.
Frågeparametrar
Name
page_num
Type
integer
standard 1
Description
Sidnummer för paginering.
Name
page_size
Type
integer
standard 10
Description
Gräns för sidstorlek. Maximalt tillåtet är 100 objekt.
Name
sort_by
Type
string
standard -created_at
Description
Fält att sortera efter. Tillgängliga värden:
+created_at: Sortera efter skapandetid i stigande ordning.
-created_at: Sortera efter skapandetid i fallande ordning.
Objektet Vinyl Figure Prototype Task är en arbetsenhet som Meshy håller reda
på för att generera en konceptbild i vinylfigur-stil från ett källfoto.
Resultatet av detta steg kedjas vidare till
byggsteget via input_task_id.
Egenskaper
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id som implementationsdetalj bör du inte göra några antaganden om id:ts format.
Name
type
Type
string
Description
Typ av uppgift. Värdet är creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Uppgiftsnamnet som angavs när uppgiften skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Uppgiftens progress. Om uppgiften ännu inte har startat kommer den här egenskapen att vara 0. När uppgiften har lyckats blir den 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
En tidsstämpel representerar antalet millisekunder som förflutit sedan 1 januari 1970 UTC, enligt
standarden RFC 3339.
Till exempel representeras fredagen den 1 september 2023 kl. 12:00:00 GMT som 1693569600000. Detta gäller
för alla tidsstämplar i Meshy API.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften ännu inte har startat kommer denna egenskap att vara 0.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften ännu inte är avslutad kommer denna egenskap att vara 0.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet i det här fältet är endast meningsfullt om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Feldetaljer för misslyckade uppgifter. Se Fel för fullständig referens av objektet task_error.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Finns när uppgiftens status är PENDING, IN_PROGRESS, eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).
Name
image_urls
Type
array of strings
Description
Nedladdningsbara URL:er för de konceptbildskandidater som genererats av denna prototyp-uppgift. För närvarande returnerar API:et alltid exakt en kandidat; fältet är en array så att framtida revideringar kan tillhandahålla flera kandidater utan en brytande ändring.
Vinyl Figure Build Task-objektet är en arbetsenhet som Meshy håller reda på
för att generera en texturerad 3D-vinylfigur från en lyckad prototyptask.
Den kör samma bild-till-3D-pipeline som används av Bild till 3D,
så utdatafälten speglar det endpointens task-objekt.
Egenskaper
Name
id
Type
string
Description
Unik identifierare för tasken.
Name
type
Type
string
Description
Typ av task. Värdet är creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Task-namnet som angavs när tasken skapades. Tom sträng om inget namn angavs.
Name
status
Type
string
Description
Status för tasken. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress för tasken. Om tasken inte har startats än blir detta värde 0. När tasken har lyckats blir det 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när tasken skapades, i millisekunder.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när tasken startades, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när tasken avslutades, i millisekunder.
Name
expires_at
Type
timestamp
Description
Tidsstämpel för när taskresultatet upphör att gälla, i millisekunder.
Name
preceding_tasks
Type
integer
Description
Antalet föregående tasks. Har endast betydelse när status är PENDING.
Name
task_error
Type
object
Description
Feldetaljer för misslyckade tasks. Se Fel för den fullständiga referensen till task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna task. Returnerar 0 för FAILED-tasks (credits återbetalas vid fel).
Name
prompt
Type
string
Description
Alltid tom för vinyl figure build. Finns för kompatibilitet mellan endpoints med den delade V2ImageTo3DTaskResponse-formen som används av Bild till 3D.
Name
negative_prompt
Type
string
Description
Alltid tom för vinyl figure build. Finns för kompatibilitet mellan endpoints.
Name
texture_prompt
Type
string
Description
Alltid tom för vinyl figure build. Finns för kompatibilitet mellan endpoints.
Name
texture_image_url
Type
string
Description
Alltid tom för vinyl figure build. Finns för kompatibilitet mellan endpoints.
Name
model_urls
Type
object
Description
Nedladdningsbara URL:er för den genererade 3D-modellen. Vinyl figure build genererar en texturerad GLB plus OBJ + MTL-paret för pipelines som föredrar Wavefront OBJ. Fältets form matchar objektet Image to 3D model_urls så att framtida formattillägg passar in utan en brytande ändring.
Name
glb
Type
string
Description
Nedladdningsbar URL till den texturerade GLB-filen.
Name
obj
Type
string
Description
Nedladdningsbar URL till Wavefront OBJ-filen (geometri + UV).
Name
mtl
Type
string
Description
Nedladdningsbar URL till OBJ-filens tillhörande MTL-materialfil. Kombinera med obj och posten från texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Nedladdningsbar URL till miniatyrbilden av modellfilen.
Name
texture_urls
Type
array
Description
En array med textur-URL-objekt som genererats av denna task. Innehåller för närvarande ett enda objekt med bas-färgkartan.