Meshy Uv Unwrap API Documentation

Meshy Uv Unwrap API Documentation

Playground

Meshy UV Unwrap unwraps the UVs of a 3D model. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.

Features

Meshy UV Unwrap generates a clean UV layout for an existing 3D model, preparing its surface for texturing, material work, and downstream editing.

Why Choose This?

• Automatic UV generation — Create new UV coordinates for an existing 3D model.
• Texture preparation — Prepare models for AI texturing, manual painting, and material workflows.
• Clean UV layout — Generate non-overlapping UV regions for more reliable texture placement.
• Simple workflow — Upload a model and generate a UV-unwrapped asset without additional settings.

Parameters

How to Use

1. Upload a model — Provide the source 3D asset.
2. Submit — Generate a new UV layout for the model.
3. Download — Retrieve the UV-unwrapped model.
4. Continue texturing — Open the result in a 3D editor or use it in a downstream texturing workflow.

Pricing

$0.20 per model.

Best Use Cases

• Texture preparation — Prepare models before applying new textures or materials.
• AI texturing — Create UV coordinates before running an AI texturing workflow.
• Manual texture painting — Prepare models for Blender, Substance Painter, or similar tools.
• Imported models — Add new UVs to models with missing or unsuitable UV layouts.
• Post-remesh workflows — Generate a clean UV layout after changing model topology.

Pro Tips

• Run UV Unwrap before texturing when the model does not already have a suitable UV layout.
• Use Remesh first when the model exceeds the supported face-count limit.
• Inspect the generated UV islands in your preferred 3D editor before beginning detailed texture work.
• Skip UV unwrapping when the model already has a clean UV layout that you want to preserve.

Notes

• Models are limited to 40,000 faces for UV unwrapping.
• Models above the face limit should be remeshed before running UV Unwrap.
• UV coordinates are stored in the processed 3D model; the result is not a standalone texture image.
• UV Unwrap generates new UV coordinates but does not paint a new texture.
• Existing textures are not preserved in the UV-unwrapped result.
• Quad and n-gon geometry is triangulated during UV generation.
• The processed model is returned as a GLB file.

Authentication

For authentication details, please refer to the Authentication Guide.

API Endpoints

Submit Task & Query Result

set -euo pipefail

export WAVESPEED_API_KEY="your-api-key"

REQUEST_BODY=$(cat <<'JSON'
{
  "model": "example"
}
JSON
)

# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
  --connect-timeout 10 --max-time 60 \
  -X POST "https://api.wavespeed.ai/api/v3/meshy/uv-unwrap" \
  -H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
  -H "Content-Type: application/json" \
  -d "${REQUEST_BODY}"); then
  printf 'Submit failed. %s\n' "${CHECK}" >&2
  exit 1
fi

TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
  printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
  exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"

# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
  # Transient errors (429, 5xx) are retried, honoring Retry-After.
  HTTP_CODE=$(curl --silent --show-error --fail-with-body \
    --connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
    --output "${BODY_FILE}" --write-out '%{http_code}' \
    "${RESULT_URL}" \
    -H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
  case "${HTTP_CODE}" in
    2??) ;;
    000|429|5??)  # dropped connection or temporary error: keep polling
      printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
      sleep 10; continue ;;
    *) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
      cat "${BODY_FILE}" >&2; exit 1 ;;
  esac
  RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
  STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')

  case "${STATUS}" in
    completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
    failed|cancelled|timeout|deleted)
      printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
      printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
    *) sleep 2 ;;
  esac
done

Parameters

Task Submission Parameters

Request Parameters

Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.

Response Parameters

Result Request Parameters

Result Response Parameters