Formaat wijzigen API

De Formaat wijzigen API stelt je in staat om bestaande 3D-modellen aan te passen aan realistische afmetingen. Je kunt een exacte hoogte specificeren, een beperking voor de langste zijde instellen, of AI automatisch de juiste grootte laten schatten.


POST/openapi/v1/resize

Maak een Formaat Wijzigen Taak

Deze endpoint creëert een nieuwe formaat wijzigen taak.

Parameters

  • Name
    input_task_id
    Type
    string
    Verplicht
    Description

    De ID van een voltooide Meshy taak waarvan je het model wilt wijzigen. De taak moet een status van SUCCEEDED hebben. Het uitvoerformaat zal GLB zijn.

  • Name
    model_url
    Type
    string
    Verplicht
    Description

    Een openbaar toegankelijke URL of data URI die naar een 3D-modelbestand verwijst. Ondersteunde formaten: .glb, .gltf, .obj, .fbx, .stl. Voor Data URI's, gebruik de MIME type: application/octet-stream. Het uitvoerformaat zal het originele formaat van het invoermodel behouden.

  • 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-visie om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig te wijzigen. De oorsprong zal standaard bottom zijn, 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 result eigenschap van de respons bevat de id van de nieuw aangemaakte formaat wijzigen taak.

Foutmodi

  • 400 - Bad Request

Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:

  • Ontbrekende parameter: Ofwel model_url of input_task_id moet worden verstrekt.
  • Ontbrekende formaat wijzigen mode: Minstens één van resize_height, resize_longest_side, of auto_size moet worden gespecificeerd.
  • 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

Haal een Formaat wijzigen Taak op

Deze endpoint haalt een formaat wijzigen taak op via zijn ID.

Parameters

  • Name
    id
    Type
    path
    Description

    De ID van de formaat wijzigen taak om op te halen.

Retourneert

Het Formaat wijzigen Taak object.

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 Formaat wijzigen Taak Verwijderen

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

Padparameters

  • Name
    id
    Type
    path
    Description

    De ID van de formaat wijzigen taak 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

Lijst Formaat wijzigen Taken

Deze endpoint stelt je in staat om een lijst van formaat wijzigen taken op te halen.

Parameters

  • Name
    page_num
    Type
    integer
    standaard 1
    Description

    Paginanummer voor paginering.

  • Name
    page_size
    Type
    integer
    standaard 10
    Description

    Limiet voor paginagrootte. Maximum toegestaan is 50 items.

  • Name
    sort_by
    Type
    string
    Description

    Veld om op te sorteren. Beschikbare waarden:

    • +created_at: Sorteren op creatietijd in oplopende volgorde.
    • -created_at: Sorteren op creatietijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst van De Formaat wijzigen Taak Objecten.

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

Stream een Formaat wijzigen Taak

Deze endpoint streamt real-time updates voor een formaat wijzigen taak met behulp van Server-Sent Events (SSE).

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identificatie voor de formaat wijzigen taak om te streamen.

Retourneert

Retourneert een stream van De Formaat wijzigen Taak Objecten als Server-Sent Events.

Voor PENDING of IN_PROGRESS taken, zal de responsstream alleen de noodzakelijke progress en status velden bevatten.

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 Formaat Wijzigen Taakobject

Het Formaat Wijzigen Taakobject vertegenwoordigt een formaat wijzigingsopdracht.

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 met gewijzigd formaat. Bij gebruik van input_task_id is de output altijd GLB. Bij gebruik van model_url behoudt de output het originele formaat.

  • 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 zinvol wanneer de status PENDING is.

  • created_at · timestamp

Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.

  • started_at · timestamp

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

  • finished_at · timestamp

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

  • task_error · object

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

  • consumed_credits · integer

Het aantal credits verbruikt door deze taak (1 credit per formaat wijzigingstaak). Geeft 0 terug voor FAILED taken.