Flerfärgsutskrift API

Konvertera 3D-modeller till flerfärgs 3MF-format för 3D-utskrift, med en konfigurerbar färgpalett på upp till 16 färger.

POST/openapi/v1/print/multi-color

Skapa en flerfärgad 3D-utskrift

Detta endpoint skapar en ny flerfärgad 3D-utskrift. Uppgiften konverterar en 3D-modell till en flerfärgad 3MF-fil lämplig för 3D-utskrift.

Parametrar

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

  • Name
    model_url
    Type
    string
    Obligatorisk
    Description

    Offentligt tillgänglig URL eller Data URI för en 3D-modell. Vi stödjer för närvarande .glb och .fbx format.

  • Name
    max_colors
    Type
    integer
    standard 4
    Description

    Maximalt antal färger i utgångspaletten.

    Giltigt intervall: 1 till 16.

  • Name
    style
    Type
    string
    standard realistic
    Description

    Visuell färgstil för den genererade 3MF-filen.

    Tillgängliga värden:

    • realistic: Samplar färger direkt från modellens textur för fin, fotorealistisk detalj. Producerar en större fil.
    • cartoon: Plattar ut färger till rena, enhetliga områden för en stiliserad look. Producerar en mindre fil.

Returnerar

result-egenskapen i svaret innehåller id för den nyligen skapade 3D-utskriftsuppgiften.

Feltyper

  • Name
    400 - Bad Request
    Description

    Begäran var oacceptabel. Vanliga orsaker:

    • Saknad parameter: Antingen model_url eller input_task_id måste tillhandahållas.
    • Ogiltigt modelformat: model_url pekar på en fil med en ej stödd filändelse (endast .glb och .fbx stöds).
    • Oåtkomlig URL: model_url kunde inte laddas ner.
    • Ogiltig indatauppgift: input_task_id måste referera till en lyckad uppgift.
    • Ogiltig max_colors: Värdet måste vara mellan 1 och 16.
    • Ogiltig stil: Värdet måste vara realistic eller cartoon.
  • Name
    401 - Unauthorized
    Description

    Autentisering misslyckades. Kontrollera din API-nyckel.

  • Name
    402 - Payment Required
    Description

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

  • Name
    429 - Too Many Requests
    Description

    Du har överskridit din hastighetsgräns.

Request

POST
/openapi/v1/print/multi-color
# Convert a 3D model to multi-color 3MF for printing
curl https://api.meshy.ai/openapi/v1/print/multi-color \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "max_colors": 8
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
GET/openapi/v1/print/multi-color/:id

Hämta en flerfärgad 3D-utskrift

Detta endpoint hämtar en flerfärgad 3D-utskrift med dess ID.

Parametrar

  • Name
    id
    Type
    path
    Description

    ID för den 3D-utskrift som ska hämtas.

Returnerar

Objektet för 3D-utskriften.

Request

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}
DELETE/openapi/v1/print/multi-color/:id

Ta bort en flerfärgad 3D-utskriftsuppgift

Detta endpoint tar permanent bort en flerfärgad 3D-utskriftsuppgift, inklusive alla associerade modeller och data. Denna åtgärd är oåterkallelig.

Sökvägsparametrar

  • Name
    id
    Type
    path
    Description

    ID för den flerfärgade 3D-utskriftsuppgiften som ska tas bort.

Returnerar

Returnerar 200 OK vid framgång.

Request

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

Response

// Returns 200 Ok on success.
GET/openapi/v1/print/multi-color

Lista Multi-Color 3D Print-uppgifter

Detta endpoint tillåter dig att hämta en lista över multi-color 3D print-uppgifter.

Parametrar

Valfria attribut

  • Name
    page_num
    Type
    integer
    Description

    Sidnummer för paginering. Börjar och standard är 1.

  • Name
    page_size
    Type
    integer
    Description

    Sidstorleksgräns. Standard är 10 objekt. Max 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 av The 3D Print Task Objects.

Request

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-multi-color",
    "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
  "consumed_credits": 10
  }
]
GET/openapi/v1/print/multi-color/:id/stream

Strömma en flerfärgad 3D-utskrift

Denna endpoint strömmar realtidsuppdateringar för en flerfärgad 3D-utskrift med hjälp av Server-Sent Events (SSE).

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för den flerfärgade 3D-utskrift som ska strömmas.

Returnerar

Returnerar en ström av 3D-utskriftsobjekt 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/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-multi-color",
  "model_urls": {
    "3mf": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.3mf?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}

3D-utskriftsuppgiftsobjektet

  • Name
    id
    Type
    string
    Description

    Unik identifierare för uppgiften. Även om vi använder ett k-sorterbart UUID för uppgifts-id:n som implementeringsdetalj, bör du inte göra några antaganden om id-formatet.

  • Name
    type
    Type
    string
    Description

    Typ av 3D-utskriftsuppgift. Värdet är print-multi-color.

  • Name
    model_urls
    Type
    object
    Description

    Nedladdningsbar URL till 3D-modellfilen genererad av Meshy. Egenskapen för ett format kommer att utelämnas om formatet inte genereras istället för att returnera en tom sträng.

    • Name
      3mf
      Type
      string
      Description

      Nedladdningsbar URL till flerfärgs-3MF-filen.

  • Name
    progress
    Type
    integer
    Description

    Framsteg för uppgiften. Om uppgiften inte har startat ännu, kommer denna egenskap att vara 0. När uppgiften har lyckats, kommer detta att bli 100.

  • Name
    status
    Type
    string
    Description

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

  • Name
    preceding_tasks
    Type
    integer
    Description

    Antalet föregående uppgifter.

    Värdet av detta fält är meningsfullt endast om uppgiftens status är PENDING.

  • Name
    created_at
    Type
    timestamp
    Description

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

  • Name
    started_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startat ännu, kommer denna egenskap att vara 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften inte har avslutats ännu, kommer denna egenskap att vara 0.

  • Name
    task_error
    Type
    object
    Description

    Felformationer för misslyckade uppgifter. Se Fel för fullständig referens av task_error-objektet.

  • Name
    consumed_credits
    Type
    integer
    Description

    Antalet credits som förbrukats av denna uppgift. Förekommer när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).

The 3D Print Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}