Meshy V6 Draft Completion

THREE_Dmeshy-v6-draft-complete

Meshy V6 Draft Completion finishes a Meshy Meshy V6 text-to-3D draft. A draft is the untextured mesh, quick and low-cost to try ideas with; completing it textures that same mesh, and can rig and animate it. Meshy keeps a draft for 3 days, after which it has to be generated again.

POST

/v2/workspaces/{workspace_id}/base-models/meshy-v6-draft-complete/inferences

curl --request POST \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "include_textures": true,
  "pbr_materials": false,
  "texture_resolution": "NONE",
  "guidance_file_draft_mesh": [
    {
      "url": "<file_url>"
    }
  ]
}'

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences"

payload = {
    "include_textures": True,
    "pbr_materials": False,
    "texture_resolution": "NONE",
    "guidance_file_draft_mesh": [{ "url": "<file_url>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"include_textures":true,"pbr_materials":false,"texture_resolution":"NONE","guidance_file_draft_mesh":[{"url":"<file_url>"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences"

  payload := strings.NewReader("{\n  \"include_textures\": true,\n  \"pbr_materials\": false,\n  \"texture_resolution\": \"NONE\",\n  \"guidance_file_draft_mesh\": [\n    {\n      \"url\": \"<file_url>\"\n    }\n  ]\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'include_textures' => null,
    'pbr_materials' => null,
    'texture_resolution' => 'NONE',
    'guidance_file_draft_mesh' => [
        [
                'url' => '<file_url>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"include_textures\": true,\n  \"pbr_materials\": false,\n  \"texture_resolution\": \"NONE\",\n  \"guidance_file_draft_mesh\": [\n    {\n      \"url\": \"<file_url>\"\n    }\n  ]\n}");
Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"include_textures\": true,\n  \"pbr_materials\": false,\n  \"texture_resolution\": \"NONE\",\n  \"guidance_file_draft_mesh\": [\n    {\n      \"url\": \"<file_url>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/base-models/meshy-v6-draft-complete/inferences");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"include_textures\": true,\n  \"pbr_materials\": false,\n  \"texture_resolution\": \"NONE\",\n  \"guidance_file_draft_mesh\": [\n    {\n      \"url\": \"<file_url>\"\n    }\n  ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);

Authorizations

bearerAuth
oauth2

Parameters

Path Parameters

workspace_id

required

Workspace Id

Id of the workspace that owns the resource.

string format: uuid

Id of the workspace that owns the resource.

Query Parameters

session_name

Session Name

Organize this run under a named session. A new session is created if none matches.

string

nullable

Organize this run under a named session. A new session is created if none matches.

Header Parameters

Idempotency-Key

string

<= 255 characters

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request Body^required

application/json

Meshy V6 Draft Completion

object

include_textures

Generate textures

Paint colour onto the mesh. Off returns bare geometry.

boolean

default: true

pbr_materials

PBR materials

Add metalness, roughness and normal maps so the model reacts to light in a game engine.

boolean

enable_rigging

Rigging

Add a skeleton so the model is ready to animate.

boolean

nullable

texture_resolution

Texture size

Resolution of the painted texture. 8K costs extra.

string

default: NONE

Allowed values: NONE RES_2K RES_4K RES_8K

remove_lighting

Remove lighting

Strip baked highlights and shadows from the texture so it lights evenly in a game engine.

Advanced field.

boolean

default: true

guidance_file_draft_mesh

required

Draft

The draft to complete at full quality

Array<object>

>= 1 items

InferenceFormFileRef

A single guidance/reference file supplied to a reference_image_list field.

The slot’s guidance type is fixed by the field it’s attached to; the caller supplies the file (its URL, or the id of a file it can read) and, where the model supports per-file weighting, a weight.

object

url

required

Url

The file’s URL, or the id of a file in this workspace or a public file.

string

weight

Weight

number

nullable

Example

{
  "include_textures": true,
  "pbr_materials": false,
  "texture_resolution": "NONE",
  "guidance_file_draft_mesh": [
    {
      "url": "<file_url>"
    }
  ]
}

Responses

202

Successful Response

application/json

ExecuteForgeOutput

object

inference_id

required

Inference Id

Unique identifier for this forge run.

string format: uuid

status

required

InferenceStatus

Current status: IN_PROGRESS.

string

Allowed values: in_progress complete failed cancelled deleted

estimated_price_creative_units

Estimated Price Creative Units

Estimated price in Creative Units.

number

nullable

poll_interval_seconds

required

Poll Interval Seconds

Suggested polling interval in seconds.

integer

created_at

required

Created At

Timestamp of when the run was created.

string format: date-time

session_id

Session Id

Session ID the run was added to, if a session was specified.

string format: uuid

nullable

normalized_parameters

Any of:

NormalizedInferenceParameters
null

NormalizedInferenceParameters

Inference parameters after model-specific normalization.

These reflect the actual values used for generation, including model defaults applied for any parameters not explicitly set.

object

width

Width

Resolved output width in pixels.

integer

nullable

height

Height

Resolved output height in pixels.

integer

nullable

batch_size

Batch Size

Number of outputs to generate.

integer

nullable

num_inference_steps

Num Inference Steps

Resolved number of diffusion steps.

integer

nullable

guidance_scale

Guidance Scale

Resolved guidance scale.

number

nullable

duration_seconds

Duration Seconds

Resolved output length in seconds — video duration or audio clip length.

number

nullable

fps

Fps

Resolved FPS.

integer

nullable

Example

{
  "status": "in_progress"
}

401

Unauthenticated — missing or invalid Bearer token.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

403

Forbidden — insufficient permissions, or the access token lacks the scope the operation requires.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

404

Resource not found.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

409

The request with this Idempotency-Key is still running — retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

422

Invalid input parameters, or an Idempotency-Key reused for a different request.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

429

Rate limited — retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

500

Internal server error.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

Meshy V6 Draft Completion

Authorizations

Parameters

Path Parameters

Query Parameters

Header Parameters

Request Bodyrequired

Example

Responses

202

Example

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

Request Body^required