Skip to main content

meshy/relief/image-to-3d

Meshy Relief turns one photo into an embossed or engraved plaque for 3D printing or CNC carving, returning an untextured GLB, an STL and a 16-bit depth map, with size and carving depth set in millimeters.

From $0.96/request

Workbench

Send a request

Quickstart

Examples use the selected endpoint’s public parameter definitions. Replace the API key and example media, then send the request from your server.

SDKs & integrations
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

API authentication

Keep the API key in the server environment variable SPICY_API_KEY. Use Bearer authentication and Content-Type: application/json for JSON requests.

Authorization: Bearer $SPICY_API_KEY
Meshy Relief · Photo to Relief · Sample output
Sample outputUse this example
# Generate the idempotency key once; reuse it when retrying after a lost response.
export SPICY_IDEMPOTENCY_KEY="${SPICY_IDEMPOTENCY_KEY:-$(uuidgen)}"
curl -X POST https://api.spicyapi.ai/api/v1/jobs/createTask \
  -H "Authorization: Bearer $SPICY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SPICY_IDEMPOTENCY_KEY" \
  -d '{
  "model": "meshy/relief/image-to-3d",
  "input": {
    "bend_axis": "xz",
    "bend_mode": "off",
    "carving_mode": "emboss",
    "image_url": "https://example.com/reference.png",
    "relief_height": "low"
  }
}'

# Copy data.taskId from the response into TASK_ID, then poll the status.
TASK_ID="TASK_ID_FROM_RESPONSE"
curl "https://api.spicyapi.ai/api/v1/jobs/recordInfo?taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Generated from this model’s input schema — the same one the API validates every request against.

Input parameters

Place these fields inside the request body’s input object. Names and types match the API. Do not assume a default when none is specified.

image_urlstringRequired

Required JPEG, PNG or WebP photo, at least 32 x 32 pixels and at most 20 MB; no image is supplied by default. A clear subject and simple background help; the input does not change the fixed rate.

Default
Not specified
Constraints
minLength:1
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
mesh_resolutionintegerOptional

Number of mesh points along the long dimension: 512–1024, default 1024. Lower values reduce detail and file size, at the same per-relief price.

Default
1024
Constraints
minimum:512
maximum:1024
bend_anglenumberOptional

Bending angle in degrees, from 0 to 360 and defaulting to 60; use with convex or concave mode. The selected angle does not affect cost.

Default
60
Constraints
minimum:0
maximum:360
bend_axisstringOptional

xz (default) curls the left and right sides; yz curls the top and bottom. The axis matters when bending is enabled and has no billing effect.

Default
"xz"
Allowed values
"xz""yz"
bend_modestringOptional

off (default) keeps a flat plate; convex bends outward and concave bends inward. Curvature mode adds no fee.

Default
"off"
Allowed values
"off""convex""concave"
removal_thresholdnumberOptional

Background-removal threshold from 0.01 to 1, default 0.01; it acts when remove_base is enabled. Higher values cut away more background without changing pricing.

Default
0.01
Constraints
minimum:0.01
maximum:1
remove_basebooleanOptional

Off by default; enable to request background and plate removal, leaving the subject. Success depends on depth separation, and the option costs no extra.

Default
false
base_thickness_mmnumberOptional

Optional plate thickness of 0.1–10 mm; no numeric default is specified here. Omit it when remove_base is enabled; thickness does not alter the rate.

Default
Not specified
Constraints
minimum:0.1
maximum:10
size_mmnumberOptional

Long dimension of the photograph on the relief, measured flat before bending: 20–250 mm, default 60 mm. Physical size leaves the charge unchanged.

Default
60
Constraints
minimum:20
maximum:250
carving_depth_mmnumberOptional

Optional depth override from 0 to 60 mm; when omitted, relief_height supplies its approximate 3 mm or 6 mm depth. Depth changes carry no surcharge.

Default
Not specified
Constraints
minimum:0
maximum:60
carving_modestringOptional

emboss is the default and raises the subject above the plate; engrave cuts nearer portions inward. Both modes use the same price.

Default
"emboss"
Allowed values
"emboss""engrave"
relief_heightstringOptional

Choose low (default, approximately 3 mm depth) or high (approximately 6 mm); carving_depth_mm overrides the preset depth, with no rate change.

Default
"low"
Allowed values
"low""high"

Track the task

HTTP 202 means the task was accepted, not completed. Save the returned taskId and query that task. Do not create another task while waiting for its result.

Accepted response
HTTP/1.1 202 Accepted
Location: /api/v1/jobs/recordInfo?taskId=job_01k3m8x9q2z4v7n5p6r8s0t1w3

{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_create",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "state": "queued",
    "estimatedCost": "0.750000"
  }
}

The accepted response includes the estimate so your app can show the same amount in task history and billing.

Read the job
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Start polling at about 2 seconds and gradually increase the interval. Stop at a terminal state. After a connection failure, query the original taskId. Retry creation only with the original idempotency key and body.

Or let the callback find you
import { verifyWebhook } from "@spicyapi/sdk";

// express.raw keeps the bytes we signed; express.json never matches.
app.post("/hooks/spicy", express.raw({ type: "application/json" }), (req, res) => {
  const { payload } = verifyWebhook({
    rawBody: req.body,
    timestamp: req.header("X-Webhook-Timestamp"),
    signature: req.header("X-Webhook-Signature"),
    payloadVersion: Number(req.header("X-Webhook-Payload-Version")),
    secret: process.env.SPICY_WEBHOOK_SECRET,
  });
  res.status(200).end();
  void handleFinishedTask(payload);
});

Pass callBackUrl when you create the task and the finished record is POSTed to you — no polling loop at all. Every delivery carries X-Webhook-Timestamp, X-Webhook-Signature and X-Webhook-Payload-Version. The signature is a base64 HMAC-SHA256 over taskId.timestamp.sha256(body), so it must be checked against the raw bytes: parsing the JSON and re-serialising it changes them and the check will fail. Failed deliveries are retried, so the same taskId can arrive twice — make the handler idempotent. Answer 2xx first and do the work afterwards; a slow handler is treated as a failed delivery.

Read the result

Consume output only when state is succeeded. On failure, use errorCode, errorMessage and request_id to investigate. Example costs and states do not represent an actual bill.

Completed response example
{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_record",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "model": "meshy/relief/image-to-3d",
    "state": "succeeded",
    "output": {
      "assets": [
        {
          "key": "tasks/2026/08/28/job_01k3m8x9q2z4v7n5p6r8s0t1w3/3f7a1c9e5b2d48f0a6c1e3d5b7f9a1c3.png",
          "mime": "image/png",
          "url": "https://example.r2.cloudflarestorage.com/results/job_01k3m8x9q2z4v7n5p6r8s0t1w3/result.png?X-Amz-Signature=SIGNATURE_FROM_RESPONSE",
          "expiresAt": "2026-08-28T12:20:08.000Z"
        }
      ]
    },
    "cost": "0.750000",
    "settled": true,
    "createdAt": "2026-08-28T12:00:00Z",
    "completedAt": "2026-08-28T12:00:30Z"
  }
}

For each available asset, open or download assets[].url directly without an API Authorization header. The signed URL expires at expiresAt; poll the task again to refresh it while the asset remains within its retention period. A pending or unavailable asset has no URL. Treat signed URLs as private.

SDKs & integrations

Use SpicyAPI in your app, terminal, AI assistant or visual workflow. Choose a setup guide below.

Use it in ComfyUI

Install the SpicyAPI nodes from ComfyUI Manager or with the command below, then search for Meshy Relief · Photo to Relief on the canvas. The node has the same options as this page and shows its price before it runs.

cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi