Formaat wijzigen API

Met de Formaat wijzigen API kun je bestaande 3D-modellen aanpassen naar afmetingen in de echte wereld. Je kunt een exacte hoogte opgeven, een beperking voor de langste zijde instellen, of AI automatisch de juiste grootte laten schatten.

POST/openapi/v1/resize

Een taak voor formaat wijzigen maken

Deze endpoint maakt een nieuwe taak voor formaat wijzigen.

Parameters

Slechts één van input_task_id of model_url is vereist. Als beide worden opgegeven, krijgt input_task_id prioriteit.

Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide Meshy-taak waarvan je het model wilt wijzigen. De taak moet de status SUCCEEDED hebben. Het uitvoerformaat is GLB.

Name
model_url
Type
string
Verplicht
Description
Een openbaar toegankelijke URL of Data URI die verwijst naar een 3D-modelbestand. Ondersteunde formaten: .glb, .gltf, .obj, .fbx, .stl. Gebruik voor Data URI's het MIME type: application/octet-stream. Het uitvoerformaat behoudt het oorspronkelijke formaat van het invoermodel.

Precies één mode voor formaat wijzigen is vereist: resize_height, resize_longest_side of auto_size. Deze drie parameters sluiten elkaar wederzijds uit.

Name
resize_height
Type
number
Description
Wijzig het formaat van het model naar een specifieke hoogte, gemeten in meters.

Name
resize_longest_side
Type
number
Description
Wijzig het formaat van het model zodat de langste zijde overeenkomt met deze waarde, gemeten in meters. De beeldverhouding blijft behouden.

Name
auto_size
Type
boolean
Description
Wanneer ingesteld op true, gebruikt de service AI-vision om automatisch de werkelijke hoogte van het object te schatten en het formaat van het model dienovereenkomstig te wijzigen. De oorsprong wordt standaard bottom, tenzij origin_at expliciet is ingesteld.

Name
origin_at
Type
string
standaard bottom
Description
Positie van de oorsprong na het wijzigen van het formaat.
Beschikbare waarden: bottom, center.

Retourneert

De eigenschap result van de respons bevat de id van de nieuw gemaakte taak voor formaat wijzigen.

Foutmodi

400 - Bad Request

Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:

Ontbrekende parameter: Ofwel model_url of input_task_id moet worden opgegeven.
Ontbrekende mode voor formaat wijzigen: Ten minste één van resize_height, resize_longest_side of auto_size moet worden opgegeven.
Wederzijds exclusieve parameters: resize_height, resize_longest_side en auto_size kunnen niet worden gecombineerd.
Ongeldige invoertaak: De input_task_id moet verwijzen naar een succesvolle taak.
Ongeldig modelformaat: De model_url verwijst naar een bestand met een niet-ondersteunde extensie.
Onbereikbare URL: De model_url kon niet worden gedownload.

401 - Unauthorized

Authenticatie mislukt. Controleer je API-sleutel.

402 - Payment Required

Onvoldoende credits om deze taak uit te voeren.

429 - Too Many Requests

Je hebt je rate limit overschreden.

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

Een taak voor Formaat wijzigen ophalen

Deze endpoint haalt een taak voor formaat wijzigen op via de ID.

Parameters

Name
id
Type
path
Description
De ID van de taak voor formaat wijzigen die moet worden opgehaald.

Retourneert

Het object van de taak voor Formaat wijzigen.

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

Een taak voor Formaat wijzigen verwijderen

Deze endpoint verwijdert permanent een taak voor formaat wijzigen, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Padparameters

Name
id
Type
path
Description
De ID van de taak voor formaat wijzigen die moet worden verwijderd.

Retourneert

Retourneert 200 OK bij succes.

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

Taken voor Formaat wijzigen weergeven

Met deze endpoint kun je een lijst met taken voor formaat wijzigen ophalen.

Parameters

Name
page_num
Type
integer
standaard 1
Description
Paginanummer voor paginering.

Name
page_size
Type
integer
standaard 10
Description
Limiet voor paginagrootte. Het maximaal toegestane aantal is 50 items.

Name
sort_by
Type
string
Description
Veld om op te sorteren. Beschikbare waarden:
- +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
- -created_at: Sorteer op aanmaaktijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst met De taakobjecten voor Formaat wijzigen.

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

Een taak voor Formaat wijzigen streamen

Deze endpoint streamt realtime-updates voor een taak voor Formaat wijzigen met behulp van Server-Sent Events (SSE).

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de taak voor Formaat wijzigen die moet worden gestreamd.

Retourneert

Retourneert een stream van De taakobjecten voor Formaat wijzigen als Server-Sent Events.

Voor taken met PENDING of IN_PROGRESS bevat de responsstream alleen de noodzakelijke velden progress en status.

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
}

Het taakobject Formaat wijzigen

Het taakobject Formaat wijzigen vertegenwoordigt een taak voor het wijzigen van formaat.

Eigenschappen

id · string

Unieke identificatie voor de taak.

type · string

Type van de taak. De waarde is resize.

model_urls · object

Downloadbare URL voor het modelbestand waarvan het formaat is gewijzigd. Bij gebruik van input_task_id is de uitvoer altijd GLB. Bij gebruik van model_url behoudt de uitvoer de oorspronkelijke indeling.

progress · integer

Voortgang van de taak (0-100).

status · string

Status van de taak. Mogelijke waarden: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · integer

Het aantal voorafgaande taken. Alleen betekenisvol wanneer de status PENDING is.

created_at · tijdstempel

Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.

started_at · tijdstempel

Tijdstempel van wanneer de taak is gestart, in milliseconden. 0 indien niet gestart.

finished_at · tijdstempel

Tijdstempel van wanneer de taak is voltooid, in milliseconden. 0 indien niet voltooid.

task_error · object

Foutobject als de taak is mislukt. Zie Fouten voor meer details.

consumed_credits · integer

Het aantal credits dat door deze taak is verbruikt (1 credit per taak voor formaat wijzigen). Retourneert 0 voor FAILED-taken.