lowpoly avvecklas den 30 okt. 2026. Byt modell före dessa datum för att undvika fel i förfrågningar. Se alla utfasningar

Creative Lab kylskåpsmagnet-API

Förvandla ett foto till en 3D-utskrivbar kylskåpsmagnet med en färgad relief och en platt baksida, i två steg. En prototyptask genererar en färglagd konceptbild från fotot. En byggtask omvandlar den bilden till en relief-3D-modell och tar prototyptaskens ID som 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

Skapa en Fridge Magnet-prototyp-task

Genererar en färglagd konceptbild från ett foto. För att bygga 3D-modellen, skicka denna tasks ID till build-endpointen som input_task_id. För taskens fält, se The Fridge Magnet prototype task object.

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"
}
Prototypexempel
Börja med ett källfoto, generera sedan prototypbilden som används av byggsteget för kylskåpsmagneten.
Källfoto på ett landskap som används som Creative Lab Fridge Magnet-indata
Prototypindata
Creative Lab Fridge Magnet-prototyputdata genererad från källfotot
Prototyputdata

Parametrar

  • Name
    image_url
    Type
    string
    Obligatorisk
    Description

    Fotot som ska omvandlas till en kylskåpsmagnet-konceptbild, antingen som en offentlig URL eller en data-URI (data:image/jpeg;base64,<your base64-encoded image data>).

    Bilden måste vara en JPG-, JPEG-, PNG- eller WebP-fil på högst 20 MB.

  • 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 returnerar 400.

  • Name
    remove_background
    Type
    boolean
    standard false
    Description

    Om bakgrunden ska tas bort från prototypbilden. true returnerar en transparent RGBA-PNG som behåller hela magneten, så att du kan placera den mot vilken bakgrund som helst. Byggsteget utgår också från bilden utan dess bakgrund. Om Meshy inte kan ta bort bakgrunden returneras bilden med sin bakgrund, och tasken lyckas ändå.

    Byggstegets remove_background-alternativ är separat.

Returvärden

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

Felscenarier

  • Name
    400 - Bad Request
    Description

    Förfrågan 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 hämta bilden, till exempel för att URL:en returnerar 404 eller tidsgränsen överskrids.
    • Data-URI:n är inte giltig base64.
    • Bilden flaggades som olämplig (NSFW).

    Felmeddelandet anger vilket problem som hittades. Åtgärda förfrågan och skicka den igen.

  • Name
    401 - Unauthorized
    Description

    API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-headern.

  • Name
    402 - Payment Required
    Description

    Något av följande gäller:

    • Kontot har inte tillräckligt med credits.
    • API-nyckeln, arbetsytan eller medlemmen har nått 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-filtrering aktiverat, och Meshy har flaggat bilden för tredjeparts immateriella rättigheter. Skicka en bild som du har rättigheter att använda.

  • Name
    429 - Too Many Requests
    Description

    En av dessa gränser har nåtts:

    • Du har skickat fler förfrågningar än vad din hastighetsgräns tillåter. Vänta några sekunder och försök sedan igen. Se Rate limits.
    • För många av dina tasks köar eller körs. Vänta tills några är klara och försök sedan igen.
    • På en obegränsad plan utan credits kvar har du nått 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 på bilden inte kunde köras. Meshy skapar inte tasken, och återbetalar eventuella credits som dragits. Försök skicka förfrågan igen.

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

Skapa en build-uppgift för kylskåpsmagnet

Genererar den 3D-utskrivbara kylskåpsmagneten från en lyckad prototyp-uppgift. Meshy omvandlar prototypens konceptbild till en djupkarte-relief och returnerar en modellfil i det format du väljer. För uppgiftens fält, se Objektet för kylskåpsmagnetens build-uppgift.

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-exempel
Build-uppgiften omvandlar den valda prototypbilden till en 3D-utskrivbar kylskåpsmagnetmodell.
Förhandsgranskning av Creative Lab Fridge Magnet build-modell
Förhandsgranskning av build-modell

Parametrar

  • Name
    input_task_id
    Type
    string
    Obligatorisk
    Description

    ID:t för den prototyp-uppgift som ska byggas. Det måste vara en uppgift som ditt konto skapade med POST /openapi/creative-lab/fridge-magnet/v1/prototype, med status SUCCEEDED.

    Ett ID som inte är en av dina Fridge Magnet-prototypuppgifter från API:et returnerar 404, inklusive en prototyp som skapats i webbappen.

  • Name
    name
    Type
    string
    Description

    Ett namn för uppgiften, upp till 100 tecken. Det kommer tillbaka i uppgiftens name-fält. Ett längre namn returnerar 400.

options

Valfria inställningar för reliefens form. Varje fält har ett standardvärde, så skicka bara de du vill ändra. Ett värde utanför ett fälts intervall returnerar 400.

  • Name
    badge_shape
    Type
    string
    standard rounded-rect
    Description

    Magnetens kontur när Meshy inte spårar den från motivet. Meshy använder den när remove_background är false, eller när den inte kan hitta motivets kontur.

    Tillgängliga värden:

    • circle
    • rounded-rect
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    standard 60
    Description

    Kantlängden på magnetens avgränsande kvadrat, i millimeter, upp till 400. 0 använder standardvärdet.

  • Name
    relief_height_mm
    Type
    number
    standard 3.3
    Description

    Reliefens maximala höjd över basen, i millimeter, från 0 till 20.

  • Name
    relief_offset_mm
    Type
    number
    standard 0
    Description

    Hur mycket reliefen ska sänkas, i millimeter, från 0 till 20. Meshy subtraherar det från reliefens höjd överallt, ner till basen.

  • Name
    base_thickness_mm
    Type
    number
    standard 2.0
    Description

    Tjockleken på den platta basplattan bakom reliefen, i millimeter, från 0 till 20. Standardbasen på 2 mm ger magneten tillräcklig kropp för att greppa kylskåpet, så att reliefen inte känns bräcklig.

  • Name
    has_closed_back
    Type
    boolean
    standard true
    Description

    Om baksidan av magneten, sidan du limmar fast magneten på, ska slutas. false lämnar baksidan öppen, som ett skal.

  • Name
    relief_curve
    Type
    string
    standard linear
    Description

    Kurvan som mappar djupkartans värden till reliefhöjd.

    Tillgängliga värden:

    • linear
    • gamma
    • s-curve
  • Name
    curve_param
    Type
    number
    standard 1.0
    Description

    Kurvans styrka, upp till 10. Kurvorna gamma och s-curve använder den, och linear ignorerar den. 0 använder standardvärdet.

  • Name
    invert_depth
    Type
    boolean
    standard false
    Description

    Om djupkartan ska inverteras, så att mörkare områden blir högre relief.

  • Name
    smoothing
    Type
    number
    standard 0.24
    Description

    Hur mycket djupkartan ska mjukas upp innan Meshy bygger reliefen, från 0 till 10.

  • Name
    relief_scale
    Type
    number
    standard 1.0
    Description

    Hur mycket reliefen och dess textur ska zoomas inom konturen, kring mitten, upp till 10. Ett värde över 1 förstorar motivet, och ett värde under 1 förminskar det. Det ändrar inte reliefens höjd. 0 använder standardvärdet.

  • Name
    depth_threshold
    Type
    number
    standard 0.1
    Description

    Djupkartans värde under vilket Meshy sätter djupet till noll, från 0 till 1.

  • Name
    remove_background
    Type
    boolean
    standard true
    Description

    Om magnetens kontur ska spåras från motivet, så att magneten följer motivets form. false använder konturen badge_shape istället. Meshy använder även badge_shape när den inte kan hitta motivets kontur.

    Detta är separat från prototypens remove_background-parameter, som styr om prototypbilden har en transparent bakgrund.

  • Name
    export_resolution
    Type
    integer
    standard 512
    Description

    Nätupplösningen för den exporterade modellen, från 64 till 512. Meshy bygger geometrin från en djupkarta på 512 pixlar, så ett finare nät skulle lägga till ytor utan att lägga till detalj. 0 använder standardvärdet.

output

Valfritt. Anger filformatet som build-uppgiften returnerar.

  • Name
    format
    Type
    string
    standard glb
    Description

    Filformatet som build-uppgiften returnerar.

    Tillgängliga värden:

    • glb: en model.glb-fil, i model_urls.glb
    • obj: en zip-fil med model.obj, model.mtl, och texture.png, i model_urls.obj
    • zip: en zip-fil med varje fil Meshy genererar, i model_urls.bundle_zip

Returnerar

Fältet result innehåller ID:t för den nya build-uppgiften. Hämta uppgiften eller strömma den tills status är SUCCEEDED. Ladda sedan ner filen från den enda posten i 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 uppgifts-ID.
    • Prototyp-uppgiftens status är inte SUCCEEDED. Om den fortfarande körs, vänta och försök igen. Om den misslyckades eller avbröts, skapa en ny prototyp-uppgift.
    • Prototyp-uppgiften lyckades men saknar bild. Skapa en ny prototyp-uppgift.
    • Ett options-fält är utanför sitt intervall eller är inte ett tillgängligt värde.

    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 nådde sin creditgräns.
    • Kontot har den gratis planen.

    Kontrollera dina credits och din plan, och försök sedan igen.

  • Name
    404 - Not Found
    Description

    input_task_id matchar ingen Fridge Magnet-prototypuppgift som ditt konto skapade med API:et. En prototyp som skapats i webbappen returnerar också 404. Skicka result-ID:t från ett prototyp-skapandesvar.

  • Name
    429 - Too Many Requests
    Description

    En av dessa gränser nåddes:

    • Du skickade fler förfrågningar än din hastighetsgräns tillåter. Vänta några sekunder och försök igen. Se Hastighetsgränser.
    • För många av dina uppgifter är köade eller körs. Vänta tills några är klara och försök igen.
    • På en obegränsad plan utan kvarvarande credits nådde du antalet uppgifter som kan köras utan credits. Vänta tills en uppgift är klar, eller lägg till credits.
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Hämta en kylskåpsmagnet-uppgift

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

För fälten, se Objektet för kylskåpsmagnet-prototypuppgift och Objektet för kylskåpsmagnet-build-uppgift.

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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametrar

  • Name
    id
    Type
    path
    Description

    Uppgifts-ID från skapandesvaret.

Returnerar

Prototypuppgiftsobjektet eller build-uppgiftsobjektet, beroende på steget i 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-filtrering påslaget, och Meshy har flaggat prototypuppgiftens bild för immateriella rättigheter som tillhör tredje part. Build-uppgifter 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 kylskåpsmagnet-uppgift med detta ID tillhör ditt konto, eller uppgiftens steg matchar 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/fridge-magnet/v1/(prototype|build)/:id

Ta bort en kylskåpsmagnet-uppgift

Avbryter en kylskåpsmagnet-uppgift. Om en PENDING-uppgift avbryts återbetalas dess credits. En IN_PROGRESS-uppgift avbryts utan återbetalning, eftersom en worker 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 ID:t för en build-uppgift 404.

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).

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

    Ett av följande gäller:

    • id är inte ett giltigt uppgifts-ID. Skicka result-ID:t från create-svaret.
    • Uppgiften har redan en slutgiltig status (SUCCEEDED, FAILED eller CANCELED), så den kan inte avbrytas.
  • Name
    404 - Not Found
    Description

    Ingen kylskåpsmagnet-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/fridge-magnet/v1/(prototype|build)/:id/stream

Streama en kylskåpsmagnet-uppgift

Streamar en kylskåpsmagnet-uppgifts uppdateringar 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/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 following PENDING frame is shortened 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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametrar

  • Name
    id
    Type
    path
    Description

    Uppgifts-ID:t från create-svaret.

Returnerar

En ström av prototype- eller build-uppgiftsobjekt. Varje händelse innehåller hela uppgiftsobjektet, så som Hämta en kylskåpsmagnet-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 Filtering blockerar uppgiftens resultat skickar strömmen istället en error-händelse, med den status_code som en get-förfrågan skulle returnera.

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

Lista uppgifter för kylskåpsmagnet

Returnerar dina uppgifter för kylskåpsmagnet 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/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=***"
    ]
  }
]

Sökvägsparametrar

  • Name
    stage
    Type
    path
    Obligatorisk
    Description

    Steget att lista, 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, matchande steget i sökvägen.

Fridge Magnet-prototypens uppgiftsobjekt

En prototyp-uppgift genererar en koloriserad konceptbild från ett foto. För att omvandla bilden till en 3D-modell, skicka uppgiftens ID till build-endpointen som input_task_id.

Egenskaper

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=***"
  ]
}
  • Name
    id
    Type
    string
    Description

    Uppgiftens ID. Förlita dig inte på dess format.

  • Name
    type
    Type
    string
    Description

    Uppgiftstypen, alltid creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

    Namnet (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 anledningen i task_error
    • CANCELED: slutgiltig, utan resultat
  • Name
    progress
    Type
    integer
    Description

    Procentandel av arbetet som är klart, från 0 till 100. Det är 0 tills uppgiften startar och 100 när den lyckas.

  • Name
    created_at
    Type
    timestamp
    Description

    Tidpunkt då uppgiften skapades, i Unix-millisekunder.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidpunkt då en worker startade uppgiften, i Unix-millisekunder. null fram tills dess.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidpunkt då uppgiften nådde en slutgiltig status, i Unix-millisekunder. null fram tills dess.

  • Name
    expires_at
    Type
    timestamp
    Description

    Tidpunkt 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

    Antal credits som debiterats för uppgiften, efter eventuell återbetalning. En förfrågan som returnerar ett fel debiteras inte. En misslyckad uppgift är 0, eftersom Meshy återbetalar den. Avbrytning återbetalar endast en uppgift medan den är PENDING. Om Meshy inte kan läsa debiteringen utelämnar ett get- eller stream-svar fältet, och en listförfrågan returnerar 500. I så fall, försök igen med förfrågan.

  • Name
    image_urls
    Type
    array of strings
    Description

    Nedladdnings-URL:er för konceptbilden. Arrayen innehåller en URL efter att uppgiften lyckats, och är tom fram tills dess.

Fridge Magnet-byggtaskobjektet

En byggtask genererar 3D-kylskåpsmagneten från en lyckad prototyptask. Den returnerar en modellfil i det format du begärde.

Egenskaper

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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?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-fridge-magnet-build.

  • 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 anledningen 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

    Tidpunkt då tasken skapades, i Unix-millisekunder.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidpunkt då en worker startade tasken, i Unix-millisekunder. null tills dess.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidpunkt då tasken nådde en slutgiltig status, i Unix-millisekunder. null tills dess.

  • Name
    expires_at
    Type
    timestamp
    Description

    Tidpunkt 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 permanent, ä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 innebär att den startar härnäst. 0 när tasken har 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 begäran 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 listbegäran returnerar 500. I så fall, försök igen med begäran.

  • Name
    model_urls
    Type
    object
    Description

    Nedladdnings-URL:er för modellfilen, med en post för det output.format du begärde. {} tills tasken lyckas.

    • Name
      glb
      Type
      string
      Description

      Nedladdnings-URL för GLB-filen. Finns när output.format är glb.

    • Name
      obj
      Type
      string
      Description

      Nedladdnings-URL för en zip-fil med model.obj, model.mtl och texture.png. Finns när output.format är obj.

    • Name
      bundle_zip
      Type
      string
      Description

      Nedladdnings-URL för en zip-fil med alla filer som Meshy genererar. Finns när output.format är zip.