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

Förvandla ett foto till en samlingsbar 3D-figur i chibi-stil i två steg. En prototypuppgift genererar en konceptbild från fotot. En bygguppgift omvandlar den bilden till en texturerad 3D-modell och tar prototypuppgiftens ID som input_task_id.

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

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

Skapa en Figure prototype-uppgift

Genererar en konceptbild i chibi-stil från ett foto. För att bygga 3D-modellen skickar du den här uppgiftens ID till build-endpointen som input_task_id. För uppgiftens fält, se The Figure prototype task object.

Request

POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Source portrait used as the Creative Lab Figure input
Prototype input
Chibi-style figurine prototype image generated from the source photo
Prototype output

Parametrar

  • Name
    image_url
    Type
    string
    Obligatorisk
    Description

    Fotot som ska omvandlas till en chibi-figur, 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 uppgiften, på upp till 100 tecken. Det returneras i uppgiftens fält name. 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, så att du kan placera motivet på valfri bakgrund. Bygget utgår då också från bilden utan dess bakgrund. Om Meshy inte kan ta bort bakgrunden returneras bilden med sin bakgrund, och uppgiften lyckas ändå.

Returvärden

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

Felsätt

  • 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 ladda ner bilden, till exempel eftersom 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 sedan igen.

  • 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 credit-grä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 som du har rätt att använda.

  • 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 sedan igen. Se Rate limits.
    • För många av dina uppgifter är köade eller pågående. Vänta tills några är klara och försök sedan igen.
    • På en obegränsad plan utan kvarvarande credits har du nått antalet uppgifter som kan köras utan credits. Vänta tills en uppgift ä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 uppgiften, och återbetalar eventuella credits som debiterats. Försök igen med förfrågan.


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

Skapa en Figure-byggtask

Genererar den texturerade 3D-figuren från en lyckad prototyptask. För dess fält, se The Figure build task object.

Request

POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Byggexempel
Byggtasken omvandlar den valda prototypbilden till en nedladdningsbar texturerad 3D-modell.
Förhandsgranskning av Creative Lab Figure-byggmodell
Förhandsgranskning av byggmodell

Parametrar

  • Name
    input_task_id
    Type
    string
    Obligatorisk
    Description

    ID:t för den prototyptask som ska byggas. Det måste vara en task som ditt konto skapade med POST /openapi/creative-lab/figure/v1/prototype, med statusen SUCCEEDED.

    Ett ID som inte tillhör någon av dina Figure-prototyptasks från API:et returnerar 404, inklusive en prototyp som skapats i webbappen.

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

Returnerar

Fältet result innehåller ID:t för den nya byggtasken. Hämta tasken eller strömma den tills status är SUCCEEDED. Ladda sedan ner den texturerade GLB-filen från model_urls.glb. För en OBJ istället, ladda ner model_urls.obj med dess materialfil från model_urls.mtl.

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.
    • Prototyptaskens 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 prototyptask.
    • Prototyptasken lyckades men saknar bild. Skapa en ny prototyptask.

    Felmeddelandet anger vilket problem som hittades.

  • 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 använder gratisplanen.

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

  • Name
    404 - Not Found
    Description

    input_task_id matchar ingen Figure-prototyptask som ditt konto skapat med API:et. En prototyp som skapats 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 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 ä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 har du nått antalet tasks som kan köras utan credits. Vänta tills en task är klar, eller lägg till credits.

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

Hämta en Figure-uppgift

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

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

Request

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-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-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Parametrar

  • Name
    id
    Type
    path
    Description

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

Returnerar

Prototyp-uppgiftsobjektet eller bygg-uppgiftsobjektet, 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 skapande-svaret.

  • Name
    403 - Forbidden
    Description

    Ditt team har IP-filtrering aktiverat, och Meshy har flaggat uppgiftens bild för tredjeparts immateriella rättigheter. Team på Enterprise-planen får inte detta fel. Skapa en prototypuppgift från en bild som du har rättigheter att använda.

  • Name
    404 - Not Found
    Description

    Ingen Figure-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/figure/v1/(prototype|build)/:id

Ta bort en figur-uppgift

Avbryter en figur-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 ID:t för en build-uppgift 404.

Request

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

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

Streama en Figure-uppgift

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

Request

GET
/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/figure/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-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

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 Get a Figure task 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 ha returnerat.


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

List Figure tasks

Returnerar dina Figure-uppgifter för ett steg, en sida åt gången. Sökvägen anger steget. /prototype returnerar endast prototyp-uppgifter, och /build returnerar endast build-uppgifter.

Request

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

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

Response (List Prototype Tasks)

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

Returer

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


Figure-prototyptaskobjektet

Ett prototyptask genererar en konceptbild i chibi-stil från ett foto. För att omvandla bilden till en 3D-modell skickar du taskets ID till build-endpointen som input_task_id.

Egenskaper

Example Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-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=***"
  ]
}
  • Name
    id
    Type
    string
    Description

    Task-ID:t. Lita inte på dess format.

  • Name
    type
    Type
    string
    Description

    Tasktypen, alltid creative-lab-figure-prototype.

  • Name
    name
    Type
    string
    Description

    Det name du skickade när du skapade tasket, eller "" om du inte skickade något.

  • Name
    status
    Type
    string
    Description

    Taskets 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 utfört arbete, från 0 till 100. Det är 0 tills tasket startar och 100 när det lyckas.

  • Name
    created_at
    Type
    timestamp
    Description

    Tidpunkten då tasket skapades, i Unix-millisekunder.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidpunkten då en worker startade tasket, i Unix-millisekunder. null fram till dess.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidpunkten då tasket nådde en slutgiltig status, i Unix-millisekunder. null fram till dess.

  • Name
    expires_at
    Type
    timestamp
    Description

    Tidpunkten då taskets resultat upphör att gälla, i Unix-millisekunder. Det är 3 dagar efter finished_at, eller 3 dagar efter created_at tills tasket är klart. 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

    Taskets position i kön medan det är PENDING. 1 betyder att det startar härnäst. 0 efter att tasket lämnat kön, och alltid 0 i listresultat.

  • Name
    task_error
    Type
    object
    Description

    Varför tasket misslyckades. null om inte status är FAILED. Se Fel.

  • Name
    consumed_credits
    Type
    integer
    Description

    Antal credits som debiterats för tasket, efter eventuell återbetalning. En begäran som returnerar ett fel debiteras inte. Ett misslyckat task är 0, eftersom Meshy återbetalar det. Att avbryta återbetalar ett task endast medan det ä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
    image_urls
    Type
    array of strings
    Description

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


Figurens build-task-objekt

En build-task genererar en texturerad 3D-figur från en lyckad prototype-task. Dess model_urls-, thumbnail_url- och texture_urls-fält har samma format som i Bild till 3D task-objektet.

Egenskaper

Example Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}
  • Name
    id
    Type
    string
    Description

    Task-ID:t. Förlita dig inte på dess format.

  • Name
    type
    Type
    string
    Description

    Task-typen, alltid creative-lab-figure-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 orsaken i task_error
    • CANCELED: slutgiltig, utan resultat
  • Name
    progress
    Type
    integer
    Description

    Procentandel av arbetet som utförts, från 0 till 100. Den ä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

    Antalet 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
    prompt
    Type
    string
    Description

    Alltid "" för en Figure build-task.

  • Name
    negative_prompt
    Type
    string
    Description

    Alltid "" för en Figure build-task, precis som prompt.

  • Name
    texture_prompt
    Type
    string
    Description

    Alltid "" för en Figure build-task, precis som prompt.

  • Name
    texture_image_url
    Type
    string
    Description

    Alltid "" för en Figure build-task, precis som prompt.

  • Name
    model_urls
    Type
    object
    Description

    Nedladdnings-URL:er för 3D-modellen, som en texturerad GLB och som en OBJ-fil med dess MTL-fil.

    • Name
      glb
      Type
      string
      Description

      Nedladdnings-URL för den texturerade GLB-filen.

    • Name
      obj
      Type
      string
      Description

      Nedladdnings-URL för OBJ-filen, med geometrin och UV:erna.

    • Name
      mtl
      Type
      string
      Description

      Nedladdnings-URL för MTL-materialfilen som hör ihop med obj. Använd den med obj och texturen i texture_urls[0].base_color.

  • Name
    thumbnail_url
    Type
    string
    Description

    Nedladdnings-URL för en förhandsgranskningsbild av modellen.

  • Name
    texture_urls
    Type
    array
    Description

    Texturkartorna, som en array med ett objekt som innehåller base color-kartan.

    • Name
      base_color
      Type
      string
      Description

      Nedladdnings-URL för base color-kartan.

  • Name
    remove_lighting
    Type
    boolean
    Description

    Om Meshy tog bort highlights och skuggor från base color-texturen.