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 nyckelring-API

Förvandla ett foto till en 3D-utskrivbar nyckelring med en färgad relief i två steg. En prototyptask genererar en färglagd konceptbild från fotot. En byggtask omvandlar den bilden till en reliefmodell i 3D och använder prototyptaskens ID som input_task_id.

  • POST /openapi/creative-lab/keychain/v1/prototype
  • POST /openapi/creative-lab/keychain/v1/build
POST/openapi/creative-lab/keychain/v1/prototype

Skapa en Keychain-prototyptask

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 Keychain-prototyptaskobjektet.

Request

POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

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.
Source photo used as the Creative Lab Keychain input
Prototype input
Creative Lab Keychain prototype output generated from the source photo
Prototype output

Parametrar

  • Name
    image_url
    Type
    string
    Obligatorisk
    Description

    Fotot som ska omvandlas till en keychain-konceptbild, som en offentlig URL eller en data URI (data:image/jpeg;base64,<dina base64-kodade bilddata>).

    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.

    Det märker tasken i din instrumentpanel och i tasklistor, och visas inte på nyckelringen. För att sätta ett namn på nyckelringen, använd name_text.

  • Name
    name_text
    Type
    string
    Description

    Ett namn att lägga till på nyckelringen, till exempel ett husdjurs eller en persons namn, upp till 10 tecken. Meshy räknar tecken, inte byte, så ett 10-tecken långt kinesiskt, japanskt eller koreanskt namn får plats. Ett längre namn returnerar 400. Utelämna det för en nyckelring utan namn.

    Namnet visas på nyckelringens framsida som en platt, färgad detalj, inte som upphöjd eller skuren text.

    Meshy trimmar omgivande blanksteg och tar bort osynliga formateringstecken. Prototyptaskobjektet returnerar resultatet som name_text, så du kan kontrollera texten innan du betalar för bygget.

    Meshy lägger till namnet i prototypsteget. Bygget behåller det, och ignorerar en name_text som skickas till build-endpointen.

    När texten inte är ren ASCII, skicka request body som UTF-8 med Content-Type: application/json; charset=utf-8. Vissa HTTP-klienter, som Windows PowerShells Invoke-RestMethod, kodar body som ISO-8859-1 som standard. Det omvandlar varje icke-latinskt tecken till ? innan requesten når Meshy, och Meshy kan inte skilja det från ett namn du avsåg att skicka.

  • 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 medaljongen, så du kan placera den mot vilken bakgrund som helst. Bygget 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å.

    Byggets remove_background-alternativ är separat.

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 sedan ID:t till build-endpointen som input_task_id.

Felscenarier

  • Name
    400 - Bad Request
    Description

    Requesten 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 får timeout.
    • Data URI:n är inte giltig base64.
    • name_text är längre än 10 tecken. Meshy avvisar den istället för att korta ner den, och debiterar inte för requesten.
    • Bilden eller name_text flaggades som NSFW.

    Felmeddelandet anger vilket problem som hittades. Åtgärda requesten 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 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 tredje parts immateriella rättigheter. Skicka en bild du har rättigheter att använda. Meshy kontrollerar endast bilden för immateriella rättigheter, inte name_text.

  • Name
    429 - Too Many Requests
    Description

    En av dessa gränser nåddes:

    • Du skickade fler requester än 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 kvarvarande credits 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 den inte kunde köra kontrollen av immateriella rättigheter på bilden. Meshy skapar inte tasken, och återbetalar eventuella credits den debiterade. Försök med requesten igen.

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

Skapa en byggnadsuppgift för Keychain

Genererar den 3D-printbara nyckelringen från en lyckad prototypuppgift. Meshy omvandlar prototypens konceptbild till en djupkartsrelief och returnerar en modellfil i det format du väljer. För uppgiftens fält, se Objektet för Keychain-byggnadsuppgift.

Request

POST
/openapi/creative-lab/keychain/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/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": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Byggexempel
Byggnadsuppgiften omvandlar den valda prototypbilden till en 3D-printbar nyckelringsmodell.
Förhandsgranskning av Creative Lab Keychain-byggnadsmodell
Förhandsgranskning av byggnadsmodell

Parametrar

  • Name
    input_task_id
    Type
    string
    Obligatorisk
    Description

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

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

  • Name
    name
    Type
    string
    Description

    Ett namn för uppgiften, upp till 100 tecken. Det returneras 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 circle
    Description

    Nyckelringens 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 40
    Description

    Kantlängden på nyckelringens avgränsningskvadrat, i millimeter, upp till 400. 0 använder standardvärdet.

  • Name
    relief_height_mm
    Type
    number
    standard 2.2
    Description

    Reliefens maximala höjd ovanför 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 0.1
    Description

    Tjockleken på den platta basplattan bakom reliefen, i millimeter, från 0 till 20.

  • Name
    has_closed_back
    Type
    boolean
    standard true
    Description

    Om baksidan av nyckelringen ska stängas. 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, medan 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 utjämnas 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 mittpunkten, 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 nyckelringens kontur ska spåras från motivet, så att nyckelringen följer motivets form. false använder istället konturen badge_shape. Meshy använder också 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 detaljer. 0 använder standardvärdet.

output

Valfritt. Anger filformatet byggnadsuppgiften returnerar.

  • Name
    format
    Type
    string
    standard glb
    Description

    Filformatet byggnadsuppgiften 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 byggnadsuppgiften. 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.
    • Prototypuppgiftens 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 prototypuppgift.
    • Prototypuppgiften lyckades men har ingen bild. Skapa en ny prototypuppgift.
    • Ett options-fält är utanför sitt intervall eller är inte ett tillgängligt värde.

    Felmeddelandet anger vilket problem det hittade.

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

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

  • Name
    404 - Not Found
    Description

    input_task_id matchar ingen Keychain-prototypuppgift som ditt konto skapade med API:et. En prototyp skapad i webbappen returnerar också 404. Skicka result-ID:t från ett svar vid skapande av prototyp.

  • 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 återstående 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/keychain/v1/(prototype|build)/:id

Hämta en nyckelring-uppgift

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

För fälten, se objektet för nyckelringens prototypuppgift och objektet för nyckelringens byggnadsuppgift.

Request

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Parametrar

  • Name
    id
    Type
    path
    Description

    Uppgifts-ID:t från skapandesvaret.

Returnerar

Prototypuppgiftsobjektet eller byggnadsuppgiftsobjektet, 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-filtrering aktiverat, och Meshy flaggade prototypuppgiftens bild för tredjeparts immateriella rättigheter. Byggnadsuppgifter 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 nyckelring-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.

  • 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/keychain/v1/(prototype|build)/:id

Ta bort en nyckelring-uppgift

Avbryter en nyckelring-uppgift. Att avbryta en PENDING-uppgift återbetalar 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 ID för en build-uppgift 404.

Request

DELETE
/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/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 create-svaret.
    • Uppgiften har redan en slutgiltig status (SUCCEEDED, FAILED eller CANCELED), så den kan inte avbrytas.
  • Name
    404 - Not Found
    Description

    Ingen nyckelring-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/keychain/v1/(prototype|build)/:id/stream

Strömma en nyckelring-uppgift

Strömmar uppdateringar för en nyckelring-uppgift som Server-Sent Events (SSE). Sökvägen måste matcha uppgiftens steg. Om den inte gör det, till exempel ett 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/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/keychain/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-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?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 det fullständiga uppgiftsobjektet, så som Hämta en nyckelring-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/keychain/v1/(prototype|build)

Lista nyckelringsuppgifter

Returnerar dina nyckelringsuppgifter 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/keychain/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-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": 6,
    "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: nyast först
    • +created_at: äldst först

Returnerar

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

Objektet för Keychain-prototyp-uppgift

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 Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "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-keychain-prototype.

  • Name
    name
    Type
    string
    Description

    name som du skickade när du skapade uppgiften, eller "" om du inte skickade något.

  • Name
    name_text
    Type
    string
    Description

    Namnet Meshy lade till på nyckelringen, efter att ha trimmat blanksteg och tagit bort osynliga formateringstecken. Utelämnas när du inte skickade name_text. För att kontrollera att din HTTP-klient kodade texten korrekt, jämför den med det du skickade.

  • 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

    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ämnar 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. 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 listförfrågan returnerar 500. Försök i så fall igen med förfrågan.

  • Name
    image_urls
    Type
    array of strings
    Description

    Nedladdnings-URL:er för konceptbilden. Arrayen har en URL efter att uppgiften lyckats, och är tom fram till dess.

Keychain-byggobjektet för uppgifter

En byggningsuppgift genererar den 3D-nyckelringen från en lyckad prototyppuppgift. Den returnerar en modellfil i formatet du begärde.

Egenskaper

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
  • Name
    id
    Type
    string
    Description

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

  • Name
    type
    Type
    string
    Description

    Uppgiftstypen, alltid creative-lab-keychain-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 arbetet som är klart, från 0 till 100. Den ä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 arbetare startade uppgiften, i Unix-millisekunder. null fram till dess.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidpunkt då uppgiften nådde en slutgiltig status, i Unix-millisekunder. null fram till 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 slutförs. 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

    Uppgiftens position i kön medan den är PENDING. 1 betyder att den startar härnäst. 0 efter att uppgiften lämnar 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 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 listförfrågan returnerar 500. I så fall, försök igen med förfrågan.

  • Name
    model_urls
    Type
    object
    Description

    Nedladdnings-URL:er för modellfilen, med en post för det output.format du begärde. {} tills uppgiften 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 varje fil som Meshy genererar. Finns när output.format är zip.