Resize API

Ändra storlek på en 3D-modell till en verklig storlek, i meter. Ange dess höjd eller längden på dess längsta sida, eller låt Meshy uppskatta objektets verkliga höjd.

POST/openapi/v1/resize

Skapa en Resize-uppgift

Skapar en Resize-uppgift. Uppgiften körs i bakgrunden. För information om hur lång tid en uppgift vanligtvis tar, se Bearbetningstider.

Request

POST

/openapi/v1/resize

# Simple: resize to a specific height
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "resize_height": 1.8
  }'

# Advanced: resize longest side with custom origin
curl https://api.meshy.ai/openapi/v1/resize \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.glb",
    "resize_longest_side": 2.0,
    "origin_at": "center"
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

Parametrar

Name
input_task_id
Type
string
Obligatorisk
Description
Krävs om du inte skickar model_url. ID:t för en uppgift som producerade en 3D-modell, till exempel en Text till 3D-, Bild till 3D-, Remesh- eller Omtexturerings-uppgift. Uppgiften måste komma från API:et och ha statusen SUCCEEDED. Meshy returnerar den omstorleksändrade modellen som en GLB-fil.

Name
model_url
Type
string
Obligatorisk
Description
Krävs om du inte skickar input_task_id. Modellen som ska ändras i storlek, som en offentlig URL eller en data-URI. Om du skickar båda använder Meshy input_task_id.
Modellen måste vara en GLB-, glTF-, OBJ-, FBX- eller STL-fil på högst 400 MB från en http- eller https-URL, eller 100 MB som en data-URI. För en data-URI, använd MIME type application/octet-stream.
En fil över 100 MB måste också följa dessa regler:
- En GLB-, glTF-, FBX- eller OBJ-fil kan ha högst 10 000 000 ytor. Meshy räknar ytor som trianglar, så en fyrhörning räknas som 2, och ett nät som ritas mer än en gång räknas en gång per kopia.
- En FBX-fil måste vara binär FBX 7.1 eller nyare.
- En GLB- eller glTF-fil får inte använda Draco-komprimering.
En GLB-, OBJ-, FBX- eller STL-fil behåller sitt format i resultatet. En .gltf-fil eller en data-URI kommer tillbaka som GLB.

Skicka exakt en av resize_height, resize_longest_side eller auto_size. Om du skickar ingen av dem, eller fler än en, returneras 400.

Name
resize_height
Type
number
Description
Modellens nya höjd i meter, större än 0. Ett negativt värde returnerar 400.

Name
resize_longest_side
Type
number
Description
Den nya längden på modellens längsta sida i meter, större än 0. Ett negativt värde returnerar 400. Meshy behåller modellens bildförhållande.

Name
auto_size
Type
boolean
Description
Om objektets verkliga höjd ska uppskattas med AI-synförmåga och modellen ska ändras i storlek till den. Om du inte anger origin_at placerar Meshy origo längst ner.

Name
origin_at
Type
string
standard bottom
Description
Var modellens origo ska placeras efter storleksändring, bottom eller center.

Returer

Fältet result i svaret innehåller ID:t för den nya Resize-uppgiften.

Felscenarier

Name
400 - Bad Request
Description
Förfrågan kan inte köras. Felmeddelandet anger vilket problem som hittades. Till exempel:
- Saknad parameter: Varken model_url eller input_task_id skickades.
- Saknat resize-läge: Ingen av resize_height, resize_longest_side och auto_size skickades.
- Ömsesidigt uteslutande parametrar: Förfrågan innehåller fler än en av resize_height, resize_longest_side och auto_size. Skicka endast en.
- Negativ storlek: resize_height eller resize_longest_side är negativ.
- Ogiltig indatauppgift: input_task_id är inte en lyckad API-uppgift med en modellfil.
- Ogiltigt modellformat: Filen i model_url har ett filtillägg som inte stöds.
- Oåtkomlig URL: Meshy kan inte ladda ner filen från model_url.
- Modellfil för stor: Filen i model_url är över 400 MB från en http- eller https-URL, eller över 100 MB som en data-URI.
- För många ytor: Filen i model_url är över 100 MB och har fler än 10 000 000 ytor. Minska antalet ytor och skicka sedan filen igen.
- ASCII FBX över 100 MB: Filen i model_url är en ASCII-FBX över 100 MB. Skicka den som binär FBX eller GLB.
- Oläsbar modellfil: Filen i model_url är över 100 MB, och Meshy kan inte läsa dess header. Till exempel är det en Draco-komprimerad GLB eller glTF, eller en binär FBX äldre än 7.1.
- Modellheader för komplex: Filen i model_url är över 100 MB, och dess header har för många nät, noder eller poster att kontrollera. Minska antalet objekt i filen och skicka den sedan igen.
Åtgärda förfrågan och skicka den sedan igen. Se Fel.
Name
401 - Unauthorized
Description
API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-headern.
Name
402 - Payment Required
Description
Till exempel:
- Otillräckliga credits: Kontot har inte tillräckligt med credits för denna uppgift, eller kontot har nått en gräns för credits. Kontrollera ditt saldo av credits och försök sedan igen.
- Gratisplan: Att skapa en uppgift kräver en betald plan. Uppgradera din plan i dina prenumerationsinställningar och försök sedan igen.
Name
403 - Forbidden
Description
input_task_id är en basreliefmodell, som denna endpoint inte kan ändra storlek på. Meddelandet är This model type does not support this operation. Skicka en annan modell.
Name
404 - Not Found
Description
input_task_id matchar ingen av dina uppgifter. Kontrollera uppgifts-ID:t och skicka sedan förfrågan igen.
Name
429 - Too Many Requests
Description
Du överskred din hastighetsgräns. Vänta och försök sedan igen. Se Hastighetsgränser.

GET/openapi/v1/resize/:id

Hämta en Ändra storlek-uppgift

Returnerar en Ändra storlek-uppgift baserat på dess ID.

Request

GET

/openapi/v1/resize/:id

curl https://api.meshy.ai/openapi/v1/resize/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "resize",
  "model_urls": {
      "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID:t från svaret vid skapandet.

Returnerar

Ändra storlek-uppgiftsobjektet.

DELETE/openapi/v1/resize/:id

Ta bort en Ändra storlek-uppgift

Tar bort en Ändra storlek-uppgift permanent, inklusive dess modeller och data. Du kan inte ångra en borttagning.

Request

DELETE

/openapi/v1/resize/:id

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/resize/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

Sökvägsparametrar

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

Uppgiftsstatus

Att ta bort en PENDING-uppgift återbetalar de credits som användes när du skapade den.

En IN_PROGRESS-uppgift kan inte tas bort. Begäran returnerar 409 Conflict, och uppgiften fortsätter att köras. Meshy återbetalar inte en uppgift som har påbörjats, så att ta bort den skulle kosta dig både credits och resultatet. Vänta tills den når SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.

Att ta bort en uppgift med en slutgiltig status (SUCCEEDED, FAILED eller CANCELED) återbetalar inte dess credits.

Returnerar

200 OK när uppgiften har tagits bort, eller 409 Conflict när uppgiften är IN_PROGRESS.

GET/openapi/v1/resize

Lista Ändra storlek-uppgifter

Returnerar en lista över dina Ändra storlek-uppgifter.

Request

GET

/openapi/v1/resize

curl https://api.meshy.ai/openapi/v1/resize?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "resize",
    "model_urls": {
      "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

Parametrar

Name
page_num
Type
integer
standard 1
Description
Sidnumret som ska returneras, upp till 255. Ett större värde returnerar 400.

Name
page_size
Type
integer
standard 10
Description
Antalet uppgifter per sida, upp till 100.

Name
sort_by
Type
string
Description
Sorteringsordningen.
Tillgängliga värden:
- +created_at: äldsta först
- -created_at: nyaste först

Returnerar

En paginerad lista med Ändra storlek-uppgiftsobjekt.

GET/openapi/v1/resize/:id/stream

Strömma en Ändra storlek-uppgift

Strömmar uppdateringar för en Ändra storlek-uppgift som Server-Sent Events (SSE).

Request

GET

/openapi/v1/resize/:id/stream

curl -N https://api.meshy.ai/openapi/v1/resize/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "resize",
  "model_urls": {
    "glb": "https://assets.meshy.ai/.../model.glb?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID från skapande-svaret.

Returnerar

En ström av Ändra storlek-uppgiftsobjekt som Server-Sent Events.

Varje event innehåller hela uppgiftsobjektet, i samma format som Get-endpointen returnerar. Medan uppgiften är PENDING eller IN_PROGRESS har dess resultatfält ännu inga värden.

Objektet Resize task

Ett Resize task-objekt beskriver en storleksändring av en 3D-modell. Det innehåller statusen, progress och modellfilen när uppgiften lyckas.

Egenskaper

Name
id
Type
string
Description
Uppgiftens ID. Behandla det som en ogenomskinlig sträng och lita inte på dess format.
Name
type
Type
string
Description
Uppgiftstypen, alltid resize.
Name
model_urls
Type
object
Description
Nedladdnings-URL för den storleksändrade modellfilen. För input_task_id är filen alltid GLB. För model_url behåller en GLB-, OBJ-, FBX- eller STL-fil sitt format, medan en .gltf-fil eller en Data URI kommer tillbaka som GLB.
Name
progress
Type
integer
Description
Hur stor del av uppgiften som är klar, i procent. Den är 0 tills uppgiften startar och 100 när den lyckas.
Name
status
Type
string
Description
Uppgiftens status, en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED eller CANCELED.
Name
preceding_tasks
Type
integer
Description
Antalet uppgifter före denna i kön. Värdet är endast meningsfullt medan uppgiften är PENDING.
Name
created_at
Type
timestamp
Description
Tidpunkt då uppgiften skapades, i Unix-millisekunder.
Name
started_at
Type
timestamp
Description
Tidpunkt då uppgiften startade, i Unix-millisekunder. Den är 0 tills uppgiften startar.
Name
finished_at
Type
timestamp
Description
Tidpunkt då uppgiften avslutades, i Unix-millisekunder. Den är 0 tills uppgiften avslutas.
Name
expires_at
Type
timestamp
Description
Tidpunkt då uppgiftens nedladdnings-URL:er upphör att gälla, i Unix-millisekunder. Den är 0 tills uppgiften avslutas.
Name
texture_urls
Type
array
Description
Nedladdnings-URL:er för modellens texturkartor, när uppgiften lyckas: en array av objekt, ett per texturset. Varje objekt har en base_color-URL och kan även ha metallic-, roughness-, normal-, emission- och metallic_roughness-URL:er. Den är null tills uppgiften lyckas, och en tom array när modellen saknar texturkartor.
Name
task_error
Type
object
Description
Felinformationen när uppgiften misslyckas. Se Fel.
Name
consumed_credits
Type
integer
Description
Antalet credits som uppgiften använde, vilket är 1 för en Resize-uppgift. Den är 0 för en FAILED-uppgift.