Konvertera API

Konvertera-API:et låter dig konvertera befintliga 3D-modeller till olika filformat.

POST/openapi/v1/convert

Skapa en Konvertera-uppgift

Denna endpoint skapar en ny formatkonverteringsuppgift.

Parametrar

Endast en av input_task_id eller model_url är obligatorisk. Om båda anges har input_task_id prioritet.

Name
input_task_id
Type
string
Obligatorisk
Description
ID:t för en slutförd Meshy-uppgift vars modell du vill konvertera. Uppgiften måste ha statusen SUCCEEDED.

Name
model_url
Type
string
Obligatorisk
Description
En offentligt tillgänglig URL eller Data URI som pekar på en 3D-modellfil. Format som stöds: .glb, .gltf, .obj, .fbx, .stl. För Data URI:er, använd MIME type: application/octet-stream.

Name
target_formats
Type
string[]
Obligatorisk
Description
En lista över utdataformat för den konverterade modellen. Tillgängliga värden: glb, fbx, obj, usdz, blend, stl, 3mf.

Returnerar

Egenskapen result i svaret innehåller id för den nyligen skapade Konvertera-uppgiften.

Fellägen

400 - Bad Request

Begäran var oacceptabel. Vanliga orsaker:

Saknad parameter: Antingen model_url eller input_task_id måste anges.
Saknad target_formats: Minst ett målformat måste anges.
Ogiltig indatauppgift: input_task_id måste referera till en framgångsrik uppgift.
Ogiltigt modellformat: model_url pekar på en fil med ett tillägg som inte stöds.
Oåtkomlig URL: model_url kunde inte laddas ned.

401 - Unauthorized

Autentisering misslyckades. Kontrollera din API-nyckel.

402 - Payment Required

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

429 - Too Many Requests

Du har överskridit din hastighetsgräns.

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

Hämta en Konvertera-uppgift

Denna endpoint hämtar en Konvertera-uppgift via dess ID.

Parametrar

Name
id
Type
path
Description
ID:t för Konvertera-uppgiften som ska hämtas.

Returnerar

Konvertera-uppgiftsobjektet.

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

Ta bort en Konvertera-uppgift

Denna endpoint tar permanent bort en Konvertera-uppgift, inklusive alla associerade modeller och data. Denna åtgärd kan inte ångras.

Sökvägsparametrar

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

Returnerar

Returnerar 200 OK vid lyckat anrop.

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

Lista Konvertera-uppgifter

Denna endpoint låter dig hämta en lista över Konvertera-uppgifter.

Parametrar

Name
page_num
Type
integer
standard 1
Description
Sidnummer för paginering.

Name
page_size
Type
integer
standard 10
Description
Sidstorleksgräns. Högsta tillåtna ä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 Konvertera-uppgiftsobjekten.

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

Strömma en Konvertera-uppgift

Denna endpoint strömmar realtidsuppdateringar för en konverteringsuppgift med hjälp av Server-Sent Events (SSE).

Parametrar

Name
id
Type
path
Description
Unik identifierare för konverteringsuppgiften som ska strömmas.

Returnerar

Returnerar en ström av Konvertera-uppgiftsobjekten som Server-Sent Events.

För PENDING- eller IN_PROGRESS-uppgifter kommer svarsströmmen endast att innehålla nödvändiga fält för progress och status.

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
}

Konvertera-uppgiftsobjektet

Konvertera-uppgiftsobjektet representerar ett formatkonverteringsjobb.

Egenskaper

id · string

Unik identifierare för uppgiften.

type · string

Typ av uppgift. Värdet är convert.

model_urls · object

Nedladdningsbara URL:er för de konverterade modellfilerna. Endast formaten som anges i target_formats kommer att ha URL:er. Andra formategenskaper kommer att vara tomma strängar.

progress · integer

Uppgiftens progress (0-100).

status · string

Uppgiftens status. 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 · tidsstämpel

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

started_at · tidsstämpel

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

finished_at · tidsstämpel

Tidsstämpel för när uppgiften slutfördes, i millisekunder. 0 om den inte har slutförts.

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 konverteringsuppgift). Returnerar 0 för FAILED-uppgifter.