Creative Lab Lampa-API

Omvandla ett foto till en 3D-utskrivbar lampskärm i två steg. En prototypuppgift genererar en matt-vit konceptbild och omvandlar den till en 3D-modell. En bygguppgift, som tar prototypuppgiftens ID som input_task_id, omvandlar den modellen till utskrivbara STL-delar. Med standardinställningen för fixtur består delarna av en lampskärm med öppen botten med en basplatta för ljusarmaturen, samt fixturfästet.

POST /openapi/creative-lab/lamp/v1/prototype
POST /openapi/creative-lab/lamp/v1/build

POST/openapi/creative-lab/lamp/v1/prototype

Skapa en lampa-prototyptask

Genererar en matt-vit konceptbild från ett foto och omvandlar den till en 3D-lampskärmsmodell. Tasken returnerar konceptbilden i image_urls, och modellen i model_urls.glb med en förhandsgranskning i thumbnail_url. För att bygga de utskrivbara delarna skickar du denna tasks ID till build-endpointen som input_task_id. För taskens fält, se Lampa-prototypens taskobjekt.

Request

POST

/openapi/creative-lab/lamp/v1/prototype

# Stage 1: concept image + 3D lampshade model from a source photo
curl https://api.meshy.ai/openapi/creative-lab/lamp/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>",
    "image_subject": "character"
  }'

Response

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

Prototypexempel

Börja med ett källfoto. Prototypen returnerar konceptbilden och 3D-modellen som byggsteget bearbetar.

Källfoto av en katt som används som input till Creative Lab Lamp — Prototypinput

Prototyputdata från Creative Lab Lamp genererad från källfotot — Prototyputdata

Parametrar

Name
image_url
Type
string
Obligatorisk
Description
Fotot som lampskärmen ska baseras på, som en offentlig URL eller en data-URI (data:image/jpeg;base64,<din base64-kodade bilddata>).
Bilden måste vara en JPG-, JPEG-, PNG- eller WebP-fil på högst 20 MB.

Name
image_subject
Type
string
standard character
Description
Typen av motiv i fotot, vilket avgör hur Meshy stiliserar det.
Tillgängliga värden:
- character: en enskild karaktär eller ett objekt, till exempel en figurin, ett djur eller en maskot
- landscape: en utomhusscen eller panorama, till exempel ett berg, en stadssiluett eller en skog
Name
name
Type
string
Description
Ett namn för tasken, upp till 100 tecken. Det returneras i taskens name-fält. Ett längre namn ger 400.
Name
remove_background
Type
boolean
standard false
Description
Om bakgrunden ska tas bort från prototypbilden. true returnerar en transparent RGBA-PNG, så att du kan placera motivet mot vilken bakgrund som helst. Meshy bygger också 3D-modellen från bilden utan dess bakgrund. Om Meshy inte kan ta bort bakgrunden används bilden med sin bakgrund, och tasken lyckas ändå.

Returvärden

Fältet result innehåller ID:t för den nya prototyptasken. Hämta tasken eller strömma den tills status är SUCCEEDED. Skicka därefter ID:t till build-endpointen som input_task_id.

Felscenarier

Name
400 - Bad Request
Description
Begäran kan inte köras. Till exempel:
- image_url saknas.
- Bilden är inte en JPG-, JPEG-, PNG- eller WebP-fil.
- Bilden är för liten, över 20 MB, eller över det maximala antalet pixlar.
- Meshy kan inte ladda ner bilden, till exempel för att URL:en returnerar 404 eller tidsgränsen överskrids.
- Data-URI:n är inte giltig base64.
- Bilden flaggades som NSFW.
- image_subject är varken character eller landscape.
Felmeddelandet anger vilket problem som hittades. Åtgärda begäran och skicka den igen.
Name
401 - Unauthorized
Description
API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-huvudet.
Name
402 - Payment Required
Description
Något av följande gäller:
- Kontot har inte tillräckligt med credits.
- API-nyckeln, arbetsytan eller medlemmen nådde sin creditgräns.
- Kontot har en gratisplan.
Kontrollera dina credits och din plan och försök sedan igen.
Name
403 - Forbidden
Description
Ditt team har IP Filtering aktiverat, och Meshy flaggade bilden för tredjeparts immateriella rättigheter. Skicka en bild du har rätt att använda.
Name
429 - Too Many Requests
Description
Någon av dessa gränser nåddes:
- Du skickade fler förfrågningar än vad din hastighetsgräns tillåter. Vänta några sekunder och försök sedan igen. Se Hastighetsgränser.
- För många av dina tasks köas eller körs. Vänta tills några är klara och försök sedan igen.
- På en obegränsad plan utan credits kvar nådde du antalet tasks som kan köras utan credits. Vänta tills en task är klar, eller lägg till credits.
Name
500 - Internal Server Error
Description
Meshy stötte på ett serverfel, till exempel för att kontrollen av immateriella rättigheter för bilden inte kunde köras. Meshy skapar inte tasken och återbetalar eventuella credits som debiterades. Försök igen med begäran.

POST/openapi/creative-lab/lamp/v1/build

Skapa ett Lamp build-task

Genererar de 3D-utskrivbara delarna från ett lyckat prototyptask. Meshy skalar prototypens modell till diameter_mm, skär botten rak enligt cut_amount_percent och håler ur den till thickness_mm. Med en fixture-förinställning öppnas även botten, en basplatta med fixturhålet läggs till, och ett separat fäste för ljuset skapas. För taskets fält, se The Lamp build task object.

Request

POST

/openapi/creative-lab/lamp/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "diameter_mm": 120,
      "thickness_mm": 2,
      "light_source_preset": "bambu_mh001_60mm",
      "cut_amount_percent": 30
    },
    "output": {
      "format": "stl"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

Build-tasket omvandlar prototypens 3D-modell till utskrivbara lampskärmsdelar.

Creative Lab Lamp build model preview — Build model preview

Parametrar

Name
input_task_id
Type
string
Obligatorisk
Description
ID för det prototyptask som ska byggas. Det måste vara ett task som ditt konto skapade med POST /openapi/creative-lab/lamp/v1/prototype, med status SUCCEEDED.
Ett ID som inte tillhör något av dina Lamp-prototyptasks från API:et returnerar 404, inklusive en prototyp som skapats i webbappen.
Name
name
Type
string
Description
Ett namn för tasket, upp till 100 tecken. Det kommer tillbaka i taskets name-fält. Ett längre namn returnerar 400.

`options`

Valfria inställningar för lampskärmens form. Varje fält har ett standardvärde, så skicka bara de du vill ändra.

Name
diameter_mm
Type
number
standard 150
Description
Storleken på lampskärmens största mått, i millimeter, från 50 till 400. Meshy skalar modellen jämnt för att passa. 0 använder standardvärdet, och alla andra värden utanför intervallet returnerar 400.
Name
thickness_mm
Type
number
standard 1
Description
Lampskärmens väggtjocklek, i millimeter, upp till 10. 0 använder standardvärdet, och ett negativt värde eller ett värde över 10 returnerar 400.
Name
cut_amount_percent
Type
number
standard 1
Description
Andelen av modellens höjd som ska skäras rak i botten, från 1 till 100. Den platta botten gör att lampskärmen kan stå på skrivarbädden och lämnar plats för fixturen. Ett värde utanför intervallet returnerar 400.
Name
light_source_preset
Type
string
standard bambu_mh001_60mm
Description
Förinställningen för ljusfixturen, som avgör hur Meshy bygger botten.
Tillgängliga värden:
- bambu_mh001_60mm: en lampskärm med öppen botten och en basplatta med ett fixturhål på 60 mm, båda i model_urls.lamp_stl, och fixturfästet i model_urls.base_stl
- none: en enda förseglad lampskärm i model_urls.lamp_stl, utan model_urls.base_stl
Name
fixture_offset_x_mm
Type
number
standard 0
Description
Hur långt fixturhålet ska flyttas längs X-axeln från lampskärmens centrum, i millimeter, från -80 till 80. Gäller endast när light_source_preset inte är none.
Name
fixture_offset_z_mm
Type
number
standard 0
Description
Hur långt fixturhålet ska flyttas längs Z-axeln (djup) från lampskärmens centrum, i millimeter, från -80 till 80. Gäller endast när light_source_preset inte är none.
Name
rotate_x_deg
Type
number
standard 0
Description
Rotationen runt X-axeln som ska appliceras på modellen innan Meshy bearbetar den, i grader, från -360 till 360. Meshy applicerar de tre rotationerna som XYZ Euler-vinklar kring modellens centrum.
Name
rotate_y_deg
Type
number
standard 0
Description
Rotationen runt Y-axeln som ska appliceras på modellen innan Meshy bearbetar den, i grader, från -360 till 360.
Name
rotate_z_deg
Type
number
standard 0
Description
Rotationen runt Z-axeln som ska appliceras på modellen innan Meshy bearbetar den, i grader, från -360 till 360.
Name
include_result_json
Type
boolean
standard false
Description
Om en result.json-fil ska läggas till i zip-paketet, med namnet på den pipeline som kördes, varningar och filvägar. Kräver att output.format är satt till zip. true med stl returnerar 400.

`output`

Valfritt. Anger vilka filer bygget returnerar.

Name
format
Type
string
standard stl
Description
Filerna som bygget returnerar.
Tillgängliga värden:
- stl: model_urls.lamp_stl, lampskärmen med sin basplatta när det finns en fixture-förinställning, och model_urls.base_stl när light_source_preset inte är none
- zip: en zip-fil i model_urls.bundle_zip, med lamp.stl, samt base.stl och result.json när det är tillämpligt

Returnerar

Fältet result innehåller ID:t för det nya build-tasket. Hämta tasket eller strömma det tills status är SUCCEEDED. Ladda sedan ner filerna från model_urls.

Felscenarier

Name
400 - Bad Request
Description
Begäran kan inte köras. Till exempel:
- input_task_id saknas eller är inte ett giltigt task-ID.
- Prototyptaskets status är inte SUCCEEDED. Om det fortfarande körs, vänta och försök igen. Om det misslyckades eller avbröts, skapa ett nytt prototyptask.
- Prototyptasket lyckades men saknar en 3D-modell. Skapa ett nytt prototyptask.
- Ett options-fält ligger utanför sitt intervall eller är inte ett tillgängligt värde.
- output.format är inte stl eller zip, eller include_result_json är true utan zip.
Felmeddelandet anger vilket problem som hittades.
Name
401 - Unauthorized
Description
API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-huvudet.
Name
402 - Payment Required
Description
Ett av följande gäller:
- Kontot har inte tillräckligt med credits.
- API-nyckeln, arbetsytan eller medlemmen har nått sin creditgräns.
- Kontot använder den kostnadsfria planen.
Kontrollera dina credits och din plan, och försök sedan igen.
Name
404 - Not Found
Description
input_task_id matchar inget Lamp-prototyptask som ditt konto skapat med API:et. En prototyp som skapats i webbappen returnerar också 404. Skicka result-ID:t från ett prototypskapande-svar.
Name
429 - Too Many Requests
Description
En av dessa gränser nåddes:
- Du skickade fler förfrågningar än vad din hastighetsgräns tillåter. Vänta några sekunder och försök igen. Se Rate limits.
- För många av dina tasks köas eller körs. Vänta tills några är klara och försök igen.
- På en obegränsad plan utan kvarvarande credits har du nått antalet tasks som kan köras utan credits. Vänta tills ett task är klart, eller lägg till credits.

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

Hämta en Lamp-uppgift

Returnerar en prototyp- eller bygguppgift. Sökvägen måste matcha uppgiftens steg. En bygguppgift som begärs via /prototype/:id returnerar 404, och detsamma gäller en prototypuppgift som begärs via /build/:id.

För fälten, se The Lamp prototype task object och The Lamp build task object.

Request

GET

/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID:t från skapandesvaret.

Returnerar

Prototypuppgiftsobjektet eller byggobjektet, beroende på vilket steg som matchar sökvägen.

Felscenarier

Name
400 - Bad Request
Description
id är inte ett giltigt uppgifts-ID. Skicka result-ID:t från skapandesvaret.
Name
403 - Forbidden
Description
Ditt team har IP Filtering aktiverat, och Meshy flaggade prototypuppgiftens bild för tredjeparts immateriella rättigheter. Bygguppgifter och team på Enterprise-planen får inte detta fel. Skapa en prototypuppgift från en bild du har rättigheter att använda.
Name
404 - Not Found
Description
Ingen Lamp-uppgift med detta ID tillhör ditt konto, eller så matchar uppgiftens steg inte sökvägen. Kontrollera ID:t, och använd /prototype eller /build för att matcha uppgiften.
Name
500 - Internal Server Error
Description
Meshy kunde inte köra kontrollen av immateriella rättigheter. Försök igen med begäran.

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

Ta bort en lampa-uppgift

Avbryter en lampa-uppgift. Om du avbryter en PENDING-uppgift återbetalas dess credits. En IN_PROGRESS-uppgift avbryts utan återbetalning, eftersom en arbetare redan har påbörjat den. En uppgift med en slutgiltig status (SUCCEEDED, FAILED eller CANCELED) kan inte avbrytas.

Sökvägen måste matcha uppgiftens steg. Till exempel returnerar DELETE på /prototype/:id med ett build-uppgifts-ID 404.

Request

DELETE

/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

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

Sökvägsparametrar

Name
id
Type
path
Description
ID:t för uppgiften som ska avbrytas.

Returnerar

204 No Content med en tom body.

Felscenarier

Name
400 - Bad Request
Description
Något av följande gäller:
- id är inte ett giltigt uppgifts-ID. Skicka result-ID:t från skaparsvaret.
- Uppgiften har redan en slutgiltig status (SUCCEEDED, FAILED eller CANCELED), så den kan inte avbrytas.
Name
404 - Not Found
Description
Ingen lampa-uppgift med detta ID tillhör ditt konto, eller så matchar inte uppgiftens steg sökvägen. Kontrollera ID:t, och använd /prototype eller /build för att matcha uppgiften.

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

Strömma en lampa-uppgift

Strömmar uppdateringar för en lampa-uppgift som Server-Sent Events (SSE). Sökvägen måste matcha uppgiftens steg. Om den inte gör det, till exempel en build-uppgifts ID på /prototype/:id/stream, skickar strömmen en error-händelse med status_code: 404 och stängs.

Request

GET

/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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 following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID:t från skapandesvaret.

Returnerar

En ström av prototype- eller build-uppgiftsobjekt. Varje händelse innehåller hela uppgiftsobjektet, så som Hämta en lampa-uppgift returnerar det. Medan uppgiften är PENDING eller IN_PROGRESS är dess utdatafält fortfarande tomma (null, [] eller {}), och finished_at är null.

Om IP-filtrering blockerar uppgiftens resultat skickar strömmen en error-händelse i dess ställe, med den status_code som en get-förfrågan skulle returnera.

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

Lista lampuppgifter (Lamp tasks)

Returnerar dina lampuppgifter för ett steg, en sida i taget. Sökvägen väljer steget. /prototype returnerar endast prototyp-uppgifter, och /build returnerar endast build-uppgifter.

Request

GET

/openapi/creative-lab/lamp/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-lamp-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 30,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Sökvägsparametrar

Name
stage
Type
path
Obligatorisk
Description
Steget som ska listas, prototype eller build.

Frågeparametrar

Name
page_num
Type
integer
standard 1
Description
Sidan som ska returneras, från 1 till 255. 0 returnerar den första sidan. Ett värde utanför 0 till 255 returnerar 400.
Name
page_size
Type
integer
standard 10
Description
Antal uppgifter per sida, upp till 100. Ett värde från 101 till 255 returnerar 100 uppgifter, och 0 använder standardvärdet. Ett värde utanför 0 till 255 returnerar 400.
Name
sort_by
Type
string
standard -created_at
Description
Sorteringsordningen.
Tillgängliga värden:
- -created_at: nyaste först
- +created_at: äldsta först

Returnerar

En array med prototyp-uppgiftsobjekt eller build-uppgiftsobjekt, beroende på steget i sökvägen.

Objektet för prototyptask för lampa

En prototyptask genererar en konceptbild i matt vitt från ett foto och omvandlar den till en 3D-modell. För att skapa de utskrivbara delarna, skicka taskens ID till build-endpointen som input_task_id.

Egenskaper

Example Lamp Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
Task-ID:t. Förlita dig inte på dess format.
Name
type
Type
string
Description
Tasktypen, alltid creative-lab-lamp-prototype.
Name
name
Type
string
Description
Det name du skickade när du skapade tasken, eller "" om du inte skickade något.
Name
status
Type
string
Description
Taskens status.
Tillgängliga värden:
- PENDING: väntar i kön
- IN_PROGRESS: genererar resultatet
- SUCCEEDED: slutgiltig, med resultatet
- FAILED: slutgiltig, med orsaken i task_error
- CANCELED: slutgiltig, utan resultat
Name
progress
Type
integer
Description
Procentandel av arbetet som utförts, från 0 till 100. Det är 0 tills tasken startar och 100 när den lyckas.
Name
created_at
Type
timestamp
Description
Tidpunkten då tasken skapades, i Unix-millisekunder.
Name
started_at
Type
timestamp
Description
Tidpunkten då en worker startade tasken, i Unix-millisekunder. null fram till dess.
Name
finished_at
Type
timestamp
Description
Tidpunkten då tasken nådde en slutgiltig status, i Unix-millisekunder. null fram till dess.
Name
expires_at
Type
timestamp
Description
Tidpunkten då taskens resultat upphör att gälla, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills tasken är klar. För Enterprise-konton, som behåller API-resultat på obestämd tid, är det ungefär 100 år senare. Se Tillgångslagring.
Name
preceding_tasks
Type
integer
Description
Taskens position i kön medan den är PENDING. 1 betyder att den startar härnäst. 0 efter att tasken lämnat kön, och alltid 0 i listresultat.
Name
task_error
Type
object
Description
Varför tasken misslyckades. null om inte status är FAILED. Se Fel.
Name
consumed_credits
Type
integer
Description
Antal credits som debiterats för tasken, efter eventuell återbetalning. En förfrågan som returnerar ett fel debiteras inte. En misslyckad task är 0, eftersom Meshy återbetalar den. Att avbryta återbetalar en task endast medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnas fältet i ett get- eller stream-svar, och en listförfrågan returnerar 500. Försök i så fall igen med förfrågan.
Name
model_urls
Type
object
Description
Nedladdnings-URL:er för 3D-modellen som genererats från konceptbilden. {} tills tasken lyckas.
- Name
  glb
  Type
  string
  Description
  Nedladdnings-URL för lampskärmsmodellen, som en GLB-fil. Byggsteget omvandlar denna modell till de utskrivbara delarna.
Name
thumbnail_url
Type
string
Description
Nedladdnings-URL för en förhandsgranskningsbild av 3D-modellen. "" tills tasken lyckas.
Name
image_urls
Type
array of strings
Description
Nedladdnings-URL:er för konceptbilden. Arrayen har en URL efter att tasken lyckats, och är tom fram till dess.

The Lamp build task object

En build-uppgift omvandlar en lyckad prototyp-uppgifts 3D-modell till utskrivbara lampskärmsdelar. Meshy ihåligör modellen och skär dess botten plan. Med en fixture-förinställning öppnar den även botten och lägger till bottenplattan och fixture-monteringen.

Egenskaper

Example Lamp Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

Name
id
Type
string
Description
Uppgifts-ID. Lita inte på dess format.
Name
type
Type
string
Description
Uppgiftstypen, alltid creative-lab-lamp-build.
Name
name
Type
string
Description
Det name du skickade när du skapade uppgiften, eller "" om du inte skickade något.
Name
status
Type
string
Description
Uppgiftens status.
Tillgängliga värden:
- PENDING: väntar i kön
- IN_PROGRESS: genererar resultatet
- SUCCEEDED: slutgiltig, med resultatet
- FAILED: slutgiltig, med orsaken i task_error
- CANCELED: slutgiltig, utan resultat
Name
progress
Type
integer
Description
Procentandel av det färdigställda arbetet, från 0 till 100. Det är 0 tills uppgiften startar och 100 när den lyckas.
Name
created_at
Type
timestamp
Description
Tidpunkten då uppgiften skapades, i Unix-millisekunder.
Name
started_at
Type
timestamp
Description
Tidpunkten då en arbetare startade uppgiften, i Unix-millisekunder. null fram till dess.
Name
finished_at
Type
timestamp
Description
Tidpunkten då uppgiften nådde en slutgiltig status, i Unix-millisekunder. null fram till dess.
Name
expires_at
Type
timestamp
Description
Tidpunkten då uppgiftens resultat upphör att gälla, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills uppgiften är klar. För Enterprise-konton, som behåller API-resultat på obestämd tid, är det ungefär 100 år senare. Se Tillgångslagring.
Name
preceding_tasks
Type
integer
Description
Uppgiftens position i kön medan den är PENDING. 1 betyder att den startar härnäst. 0 efter att uppgiften lämnat kön, och alltid 0 i listresultat.
Name
task_error
Type
object
Description
Varför uppgiften misslyckades. null om inte status är FAILED. Se Fel.
Name
consumed_credits
Type
integer
Description
Antalet credits som debiterats för uppgiften, efter eventuell återbetalning. En begäran som returnerar ett fel debiteras inte. En misslyckad uppgift är 0, eftersom Meshy återbetalar den. Att avbryta återbetalar en uppgift endast medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnas fältet i ett get- eller stream-svar, och en listbegäran returnerar 500. Försök i så fall igen med begäran.
Name
model_urls
Type
object
Description
Nedladdnings-URL:er för de utskrivbara filerna. Vilka nycklar som visas beror på output.format och options.light_source_preset.
- Name
  lamp_stl
  Type
  string
  Description
  Nedladdnings-URL för lamp.stl. Med en fixture-förinställning är det den öppna lampskärmen med bottenplattan som har fixture-hålet. Med options.light_source_preset satt till none är det en enda förseglad lampskärm. Finns med när output.format är stl.
- Name
  base_stl
  Type
  string
  Description
  Nedladdnings-URL för base.stl, monteringen för belysningsarmaturen. Finns med när output.format är stl och options.light_source_preset inte är none.
- Name
  bundle_zip
  Type
  string
  Description
  Nedladdnings-URL för en zip-fil med lamp.stl, och med base.stl och result.json när de är tillämpliga. Finns med när output.format är zip, och då utelämnas lamp_stl och base_stl.