Converteren API

De Converteren API stelt je in staat om bestaande 3D-modellen naar verschillende bestandsformaten te converteren.

POST/openapi/v1/convert

Maak een Convert Taak

Deze endpoint creëert een nieuwe formaatconversietaak.

Parameters

Slechts één van input_task_id of model_url is vereist. Als beide worden verstrekt, heeft input_task_id prioriteit.

Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide Meshy-taak waarvan je het model wilt converteren. De taak moet een status van SUCCEEDED hebben.

Name
model_url
Type
string
Verplicht
Description
Een openbaar toegankelijke URL of data URI die wijst naar een 3D-modelbestand. Ondersteunde formaten: .glb, .gltf, .obj, .fbx, .stl. Voor Data URI's, gebruik de MIME type: application/octet-stream.

Name
target_formats
Type
string[]
Verplicht
Description
Een lijst van uitvoerformaten voor het geconverteerde model. Beschikbare waarden: glb, fbx, obj, usdz, blend, stl, 3mf.

Retourneert

De result eigenschap van de respons bevat de id van de nieuw gecreëerde convert-taak.

Foutmodi

400 - Bad Request

Het verzoek was onacceptabel. Veelvoorkomende oorzaken:

Ontbrekende parameter: Ofwel model_url of input_task_id moet worden verstrekt.
Ontbrekende target_formats: Er moet ten minste één doelformaat worden gespecificeerd.
Ongeldige invoertaak: De input_task_id moet verwijzen naar een succesvolle taak.
Ongeldig modelformaat: De model_url wijst 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/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

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

GET/openapi/v1/convert/:id

Haal een Convert Taak op

Deze endpoint haalt een convert taak op via zijn ID.

Parameters

Name
id
Type
path
Description
De ID van de convert taak die moet worden opgehaald.

Retourneert

Het Convert Taak object.

Request

GET

/openapi/v1/convert/:id

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

Response

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

DELETE/openapi/v1/convert/:id

Een Convert-taak verwijderen

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

Padparameters

Name
id
Type
path
Description
De ID van de convert-taak die moet worden verwijderd.

Retourneert

Retourneert 200 OK bij succes.

Request

DELETE

/openapi/v1/convert/:id

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/convert

Lijst Converteren Taken

Deze endpoint stelt je in staat om een lijst van converteren 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 Converteren Taak Objecten.

Request

GET

/openapi/v1/convert

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

Response

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

GET/openapi/v1/convert/:id/stream

Stream een Convert Taak

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

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de convert taak om te streamen.

Retourneert

Retourneert een stream van De Convert 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/convert/:id/stream

curl -N https://api.meshy.ai/openapi/v1/convert/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": "convert",
  "model_urls": {
    "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
    "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Het Convert Task Object

Het Convert Task-object vertegenwoordigt een formaatconversieopdracht.

Eigenschappen

id · string

Unieke identificatie voor de taak.

type · string

Type van de taak. De waarde is convert.

model_urls · object

Downloadbare URL's voor de geconverteerde modelbestanden. Alleen de formaten die zijn gespecificeerd in target_formats zullen URL's hebben. Andere formaat eigenschappen zullen lege strings zijn.

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 voorgaande taken. Betekenisvol alleen 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 als niet gestart.

finished_at · tijdstempel

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 dat door deze taak is verbruikt (1 credit per convert-taak). Geeft 0 terug voor FAILED taken.