Ändra storlek API

Ändra storlek API låter dig ändra storlek på befintliga 3D-modeller till verkliga dimensioner. Du kan ange en exakt höjd, en begränsning för den längsta sidan, eller låta AI automatiskt uppskatta den lämpliga storleken.


POST/openapi/v1/resize

Skapa en Ändra storlek-uppgift

Detta endpoint skapar en ny ändra storlek-uppgift.

Parametrar

  • Name
    input_task_id
    Type
    string
    Obligatorisk
    Description

    ID för en slutförd Meshy-uppgift vars modell du vill ändra storlek på. Uppgiften måste ha statusen SUCCEEDED. Utdataformatet kommer att vara GLB.

  • Name
    model_url
    Type
    string
    Obligatorisk
    Description

    En offentligt tillgänglig URL eller data URI som pekar på en 3D-modellfil. Stödda format: .glb, .gltf, .obj, .fbx, .stl. För Data URIs, använd MIME type: application/octet-stream. Utdataformatet kommer att bevara det ursprungliga formatet för indata-modellen.

  • Name
    resize_height
    Type
    number
    Description

    Ändra storlek på modellen till en specifik höjd mätt i meter.

  • Name
    resize_longest_side
    Type
    number
    Description

    Ändra storlek på modellen så att dess längsta sida matchar detta värde, mätt i meter. Aspektförhållandet bevaras.

  • Name
    auto_size
    Type
    boolean
    Description

    När den är inställd på true, använder tjänsten AI-vision för att automatiskt uppskatta objektets verkliga höjd och ändra modellens storlek därefter. Origo kommer som standard att vara bottom om inte origin_at uttryckligen anges.

  • Name
    origin_at
    Type
    string
    standard bottom
    Description

    Positionen för origo efter storleksändring.

    Tillgängliga värden: bottom, center.

Returnerar

result-egenskapen i svaret innehåller id för den nyligen skapade ändra storlek-uppgiften.

Feltyper

  • 400 - Bad Request

Begäran var oacceptabel. Vanliga orsaker:

  • Saknad parameter: Antingen model_url eller input_task_id måste tillhandahållas.
  • Saknat ändra storlek-läge: Minst en av resize_height, resize_longest_side eller auto_size måste anges.
  • Ömsesidigt uteslutande parametrar: resize_height, resize_longest_side och auto_size kan inte kombineras.
  • Ogiltig indata-uppgift: input_task_id måste hänvisa till en lyckad uppgift.
  • Ogiltigt modellformat: model_url pekar på en fil med en ej stödd filändelse.
  • Oåtkomlig URL: model_url kunde inte laddas ner.
  • 401 - Unauthorized

Autentiseringen misslyckades. Kontrollera din API-nyckel.

  • 402 - Payment Required

Otillräckliga credits för att utföra denna uppgift.

  • 429 - Too Many Requests

Du har överskridit din hastighetsgräns.

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"
}

GET/openapi/v1/resize/:id

Hämta en Ändra storlek-uppgift

Detta endpoint hämtar en ändra storlek-uppgift med dess ID.

Parametrar

  • Name
    id
    Type
    path
    Description

    ID för den ändra storlek-uppgift som ska hämtas.

Returnerar

Objektet för Ändra storlek-uppgiften.

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
}

DELETE/openapi/v1/resize/:id

Ta bort en Ändra storlek-uppgift

Detta endpoint tar permanent bort en Ändra storlek-uppgift, inklusive alla associerade modeller och data. Denna åtgärd är oåterkallelig.

Sökvägsparametrar

  • Name
    id
    Type
    path
    Description

    ID för den Ändra storlek-uppgift som ska tas bort.

Returnerar

Returnerar 200 OK vid framgång.

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

// Returns 200 Ok on success.

GET/openapi/v1/resize

Lista Ändra storlek-uppgifter

Detta endpoint låter dig hämta en lista över uppgifter för att ändra storlek.

Parametrar

  • Name
    page_num
    Type
    integer
    standard 1
    Description

    Sidnummer för paginering.

  • Name
    page_size
    Type
    integer
    standard 10
    Description

    Begränsning av sidstorlek. Maximalt tillåtet är 50 objekt.

  • Name
    sort_by
    Type
    string
    Description

    Fält att sortera efter. Tillgängliga värden:

    • +created_at: Sortera efter skapandetid i stigande ordning.
    • -created_at: Sortera efter skapandetid i fallande ordning.

Returnerar

Returnerar en paginerad lista över Objekten för Ä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
  }
]

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

Strömma en Ändra storlek-uppgift

Detta endpoint strömmar realtidsuppdateringar för en ändra storlek-uppgift med hjälp av Server-Sent Events (SSE).

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för den ändra storlek-uppgift som ska strömmas.

Returnerar

Returnerar en ström av Objekten för Ändra storlek-uppgift som Server-Sent Events.

För PENDING eller IN_PROGRESS uppgifter kommer svarströmmen endast att inkludera nödvändiga progress och status fält.

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
}

Objektet för Ändra storlek-uppgift

Objektet för Ändra storlek-uppgift representerar ett jobb för att ändra storlek.

Egenskaper

  • id · string

Unik identifierare för uppgiften.

  • type · string

Typ av uppgift. Värdet är resize.

  • model_urls · object

Nedladdningsbar URL för den ändrade modellfilen. När input_task_id används, är utdata alltid GLB. När model_url används, bevaras det ursprungliga formatet.

  • progress · integer

Framsteg för uppgiften (0-100).

  • status · string

Status för uppgiften. Möjliga värden: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • preceding_tasks · integer

Antalet föregående uppgifter. Meningsfullt endast när status är PENDING.

  • created_at · timestamp

Tidsstämpel för när uppgiften skapades, i millisekunder.

  • started_at · timestamp

Tidsstämpel för när uppgiften startades, i millisekunder. 0 om inte startad.

  • finished_at · timestamp

Tidsstämpel för när uppgiften avslutades, i millisekunder. 0 om inte avslutad.

  • task_error · object

Felobjekt om uppgiften misslyckades. Se Fel för mer information.

  • consumed_credits · integer

Antalet credits som förbrukats av denna uppgift (1 credit per ändra storlek-uppgift). Returnerar 0 för FAILED uppgifter.