Meshy

https://docs.meshy.ai/en
Admin
Meshy provides a powerful AI-driven API and plugins for various 3D software, enabling programmatic...
Tokens:371,047
Snippets:2,321
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Python (requests): List prototype keychain tasks

Source: https://docs.meshy.ai/en/api/creative-lab-keychain

Use this Python example to list prototype tasks. It sends a GET request with the Authorization header and page_size parameter, then prints the JSON response.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

response = requests.get(
    "https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype",
    headers=headers,
    params={"page_size": 10},
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### Convert Task List Response Example

Source: https://docs.meshy.ai/en/api/convert

Example response from the GET /openapi/v1/convert endpoint. Shows a successful convert task with status SUCCEEDED, progress 100, and model URLs for FBX and STL formats.

```json
[
  {
    "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
  }
]
```

--------------------------------

### Response: List Multi-Image to 3D tasks

Source: https://docs.meshy.ai/en/api/multi-image-to-3d

Example JSON response from the GET /openapi/v1/multi-image-to-3d endpoint. Shows a task object with model URLs, thumbnail URLs, texture URLs, status, and consumed credits.

```json
[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 30
  }
  ]
```

--------------------------------

### Python: Retrieve Fridge Magnet Prototype and Build Tasks

Source: https://docs.meshy.ai/en/api/creative-lab-fridge-magnet

Use this Python example with requests to retrieve both prototype and build fridge magnet tasks. It sets the Authorization header, raises an exception on HTTP errors, and prints the JSON response. The prototype and build IDs are hardcoded for demonstration.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Prototype
prototype_id = "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
proto = requests.get(
    f"https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/{prototype_id}",
    headers=headers,
)
proto.raise_for_status()
print(proto.json())

# Build
build_id = "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
build = requests.get(
    f"https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/{build_id}",
    headers=headers,
)
build.raise_for_status()
print(build.json())
```

--------------------------------

### JavaScript (axios): Get Balance

Source: https://docs.meshy.ai/en/api/balance

Use this JavaScript example with axios to fetch the balance. It sends a GET request with the Authorization header and logs the response data. Errors are caught and logged.

```javascript
import axios from 'axios';

const headers = {Authorization: `Bearer ${YOUR_API_KEY}`};

try {
  const response = await axios.get('https://api.meshy.ai/openapi/v1/balance', {headers});
  console.log(response.data);
} catch (error) {
  console.error(error);
}
```

--------------------------------

### Python: Chain build off a succeeded prototype task

Source: https://docs.meshy.ai/en/api/creative-lab-fridge-magnet

Use this Python (requests) example to create a fridge magnet build task. It sends a POST request with the input_task_id and options, and prints the response. The payload includes badge_shape, size_mm, relief_height_mm, and output format.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Stage 2: chain build off a succeeded prototype task
payload = {
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
        "badge_shape": "rounded-rect",
        "size_mm": 60,
        "relief_height_mm": 3.3,
    },
    "output": {"format": "glb"},
}

response = requests.post(
    "https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### Build Response Example

Source: https://docs.meshy.ai/en/api/creative-lab-figure

Example response for a successful build task retrieval. Shows the task object with status SUCCEEDED, progress 100, consumed_credits 20, and model URLs.

```json
{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
```

--------------------------------

### Python (requests): Get Balance

Source: https://docs.meshy.ai/en/api/balance

Use this Python example with the requests library to retrieve the balance. It sets the Authorization header, makes a GET request, raises an exception for HTTP errors, and prints the JSON response.

```python
import requests

headers = {
  "Authorization": f"Bearer {YOUR_API_KEY}"
}

response = requests.get(
  "https://api.meshy.ai/openapi/v1/balance",
  headers=headers,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### GET /openapi/v1/uv-unwrap/:id - Retrieve an UV Unwrap Task

Source: https://docs.meshy.ai/en/api/uv-unwrap

Retrieve the current state of an UV Unwrap task by ID. The response is an UV Unwrap Task object. The cURL example uses a literal task ID, while the JavaScript and Python examples use a variable (taskId/task_id).

```bash
curl https://api.meshy.ai/openapi/v1/uv-unwrap/019361c6-9b34-7b23-bef2-d0107c4d92e2 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"
```

```javascript
import axios from 'axios';
const headers = { Authorization: `Bearer ${YOUR_API_KEY}` };
const { data } = await axios.get(
  `https://api.meshy.ai/openapi/v1/uv-unwrap/${taskId}`,
  { headers }
);
```

```python
import requests
response = requests.get(
    f"https://api.meshy.ai/openapi/v1/uv-unwrap/{task_id}",
    headers={"Authorization": f"Bearer {YOUR_API_KEY}"},
)
response.raise_for_status()
```

--------------------------------

### List Keycap Prototype Tasks with Python

Source: https://docs.meshy.ai/en/api/creative-lab-keycap

Use this Python example with requests to list keycap prototype tasks. Replace YOUR_API_KEY with your API key. The response is printed as JSON.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

response = requests.get(
    "https://api.meshy.ai/openapi/creative-lab/keycap/v1/prototype",
    headers=headers,
    params={"page_size": 10},
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### Response Example for List Text to 3D Tasks

Source: https://docs.meshy.ai/en/api/text-to-3d

Example response from the GET /openapi/v2/text-to-3d endpoint. Shows a single task object with fields such as id, type, model_urls, thumbnail_url, prompt, progress, status, texture_urls, preceding_tasks, task_error, and consumed_credits. The status is SUCCEEDED and the task consumed 20 credits.

```json
[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]
```

--------------------------------

### Python (requests): Create a lamp prototype task

Source: https://docs.meshy.ai/en/api/creative-lab-lamp

Sends a POST request with the source photo URL and subject hint using the requests library. Prints the JSON response.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Stage 1: concept image + hollow 3D lampshade model from a source photo
payload = {
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "image_subject": "character",
}

response = requests.post(
    "https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### JavaScript (axios): List Auto Split tasks

Source: https://docs.meshy.ai/en/api/auto-split

Use this JavaScript example with axios to fetch Auto Split tasks. It sends a GET request with the Authorization header and logs the response data.

```javascript
import axios from 'axios'

const headers = { Authorization: `Bearer ${YOUR_API_KEY}` };

try {
 const response = await axios.get(
   `https://api.meshy.ai/openapi/v1/print/split?page_size=10`,
  { headers }
  );
 console.log(response.data);
} catch (error) {
 console.error(error);
}
```

--------------------------------

### cURL: List prototype and build tasks

Source: https://docs.meshy.ai/en/api/creative-lab-fidget-pixel

Use cURL to list prototype tasks with /prototype and build tasks with /build. Both require an Authorization header with your API key. The example uses page_size=10.

```bash
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fidget-pixel/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fidget-pixel/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"
```

--------------------------------

### Python: Chain build off a succeeded prototype task

Source: https://docs.meshy.ai/en/api/creative-lab-keychain

Use this requests example to POST to the build endpoint. Requires an API key in the Authorization header. The response is printed as JSON, and HTTP errors raise an exception.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Stage 2: chain build off a succeeded prototype task
payload = {
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
        "badge_shape": "circle",
        "size_mm": 40,
        "relief_height_mm": 2.5,
    },
    "output": {"format": "glb"},
}

response = requests.post(
    "https://api.meshy.ai/openapi/creative-lab/keychain/v1/build",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### POST /openapi/creative-lab/lamp/v1/build

Source: https://docs.meshy.ai/en/api/creative-lab-lamp

Runs the lamp processor on the prototype model to produce printable STL parts.

```APIDOC
## POST /openapi/creative-lab/lamp/v1/build

### Description
Runs the lamp processor on the model produced by the prototype stage to generate the printable STL parts: an open-bottom lampshade with a base plate for the light-source fixture, plus the fixture mount itself. This is the second stage of the Creative Lab Lamp API.

### Method
POST

### Endpoint
/openapi/creative-lab/lamp/v1/build

### Parameters
#### Request Body
- **input_task_id** (string) - Required - The task ID from the prototype stage, used to link the build stage to the prototype output.

### Response
#### Success Response (200)
- **task_id** (string) - The ID of the created build task.

#### Response Example
{
  "task_id": "string"
}
```

--------------------------------

### JavaScript (axios): List prototype keychain tasks

Source: https://docs.meshy.ai/en/api/creative-lab-keychain

Use this axios example to list prototype tasks. It sends a GET request with the Authorization header and page_size parameter, then logs the response or error.

```javascript
import axios from 'axios'

const headers = { Authorization: `Bearer ${YOUR_API_KEY}` }

try {
  const { data } = await axios.get(
    'https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype',
    { headers, params: { page_size: 10 } }
  )
  console.log(data)
} catch (error) {
  console.error(error)
}
```

--------------------------------

### Retrieve Text to Motion Task with cURL, JavaScript, and Python

Source: https://docs.meshy.ai/en/api/text-to-motion

Retrieve a Text to Motion task by its ID using the Meshy API. The cURL command sends a GET request with a Bearer token; the JavaScript example uses axios and the Python example uses requests, both printing the response data. Replace YOUR_API_KEY with your actual API key.

```bash
curl https://api.meshy.ai/openapi/v1/text-to-motion/018c425b-b2c6-727e-d333-3c1887i9h791 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"
```

```javascript
import axios from 'axios'

const taskId = '018c425b-b2c6-727e-d333-3c1887i9h791';
const headers = { Authorization: `Bearer ${YOUR_API_KEY}` };

try {
  const response = await axios.get(
    `https://api.meshy.ai/openapi/v1/text-to-motion/${taskId}`,
    { headers }
  );
  console.log(response.data);
} catch (error) {
  console.error(error);
}
```

```python
import requests

task_id = "018c425b-b2c6-727e-d333-3c1887i9h791"
headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

response = requests.get(
    f"https://api.meshy.ai/openapi/v1/text-to-motion/{task_id}",
    headers=headers,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### POST /openapi/creative-lab/keycap/v1/build

Source: https://docs.meshy.ai/en/api/creative-lab-keycap

Creates a keycap build task that generates a textured 3D keycap model from a confirmed prototype render.

```APIDOC
## POST /openapi/creative-lab/keycap/v1/build

### Description
Turns a confirmed keycap prototype render into a textured 3D keycap model in a single run. The build task performs white-model generation, automatic seating and cutting on a calibrated default pose, full-model coloring, and final assembly. The two stages are linked via `input_task_id` plus `candidate_id`.

### Method
POST

### Endpoint
/openapi/creative-lab/keycap/v1/build

### Parameters
#### Request Body
- **input_task_id** (string) - Required - The task ID of the prototype task.
- **candidate_id** (string) - Required - The candidate ID from the prototype task result.

### Response
#### Success Response (200)
- **result** (object) - Contains the task `id` of the newly created keycap build task.

#### Response Example
```json
{
  "result": {
    "id": "string"
  }
}
```

### Notes
- Requires a paid subscription plan. Free-plan requests are rejected with `402 Payment Required`.
- Poll the Get a Task endpoint or subscribe to the stream until the task reaches `SUCCEEDED`.
```

--------------------------------

### JavaScript (axios): List Remesh tasks

Source: https://docs.meshy.ai/en/api/remesh

Use this JavaScript example with axios to fetch Remesh tasks. It sends a GET request with the Authorization header and logs the response data. Errors are caught and logged.

```javascript
import axios from 'axios'

const headers = { Authorization: `Bearer ${YOUR_API_KEY}` };

try {
 const response = await axios.get(
   `https://api.meshy.ai/openapi/v1/remesh?page_size=10`,
   { headers }
 );
 console.log(response.data);
} catch (error) {
 console.error(error);
}
```

--------------------------------

### End-to-end keycap prototype and build flow (cURL)

Source: https://docs.meshy.ai/en/api/creative-lab-keycap

Complete cURL/bash workflow for the Meshy Creative Lab Keycap API: create a prototype from a photo, poll it to SUCCEEDED, pick the first candidate, create a build, poll the build, and download the GLB and OBJ bundle. Requires curl and jq, plus MESHY_API_KEY and either IMAGE_PATH (local file) or IMAGE_URL (public URL). The script uses a 40-minute polling budget, exponential backoff (5s to 30s), and writes the request body to a temp file to avoid OS argument limits with base64 data URIs. The final download URLs are signed and valid for 3 days; no Authorization header is needed for them.

```bash
#!/usr/bin/env bash
set -euo pipefail

# Requires curl and jq. Point IMAGE_PATH at a local photo, or IMAGE_URL at a public one:
#   export MESHY_API_KEY=msy_...
#   export IMAGE_PATH=./portrait.jpg          # or: export IMAGE_URL=https://...
: "${MESHY_API_KEY:?export MESHY_API_KEY first}"
if [[ -z "${IMAGE_PATH:-}" && -z "${IMAGE_URL:-}" ]]; then
  echo "export IMAGE_PATH (local file) or IMAGE_URL (public url) first" >&2
  exit 1
fi

BASE="https://api.meshy.ai/openapi/creative-lab/keycap/v1"
AUTH="Authorization: Bearer $MESHY_API_KEY"

# api METHOD URL [curl args...] -> prints the response body, non-zero on failure.
# Note we do not use -f/--fail: it discards the body, and the body is the only
# place the reason appears.
api() {
  local method=$1 url=$2 out http_code body
  shift 2
  out=$(curl --silent --show-error --max-time 60 --write-out $'\n%{http_code}' \
    -X "$method" "$url" -H "$AUTH" "$@") || return 1
  http_code=${out##*$'\n'}
  body=${out%$'\n'*}
  if ((http_code >= 400)); then
    echo "HTTP $http_code for $url: $body" >&2
    return 1
  fi
  printf '%s' "$body"
}

# Each task gets its own 40-minute budget.
poll() {
  local kind=$1 id=$2 delay=5 task_status deadline
  deadline=$(($(date +%s) + 2400))
  while :; do
    if (($(date +%s) >= deadline)); then
      echo "gave up waiting for $kind $id" >&2
      return 1
    fi
    task_status=$(api GET "$BASE/$kind/$id" | jq -r '.status')
    echo "$kind: $task_status"
    case "$task_status" in
    SUCCEEDED) return 0 ;;
    FAILED | CANCELED) return 1 ;;
    esac
    sleep "$delay"
    delay=$((delay * 2 > 30 ? 30 : delay * 2))
  done
}

# Build the request body in a file. A base64 data URI must never go on the
# command line or into an exported variable - a photo of any real size will
# exceed the OS argument limit.
BODY=$(mktemp)
trap 'rm -f "$BODY"' EXIT
if [[ -n "${IMAGE_PATH:-}" ]]; then
  # Declare the real type: the API accepts JPEG, PNG and WebP.
  case "$(printf '%s' "${IMAGE_PATH##*.}" | tr 'A-Z' 'a-z')" in
    png) MIME=image/png ;;
    webp) MIME=image/webp ;;
    *) MIME=image/jpeg ;;
  esac
  {
    printf '{"image_url":"data:%s;base64,' "$MIME"
    base64 <"$IMAGE_PATH" | tr -d '\n'
    printf '"}'
  } >"$BODY"
else
  printf '{"image_url":"%s"}' "$IMAGE_URL" >"$BODY"
fi

# 1. Create the prototype task
PROTO_ID=$(api POST "$BASE/prototype" \
  -H 'Content-Type: application/json' --data-binary @"$BODY" | jq -r '.result')

# 2. Wait for the design render
poll prototype "$PROTO_ID"

# 3. Pick a candidate (first one here; show image_urls to a user in production)
CANDIDATE_ID=$(api GET "$BASE/prototype/$PROTO_ID" | jq -r '.candidate_ids[0]')

# 4. Create the build task
jq -n --arg p "$PROTO_ID" --arg c "$CANDIDATE_ID" \
  '{input_task_id: $p, candidate_id: $c}' >"$BODY"
BUILD_ID=$(api POST "$BASE/build" \
  -H 'Content-Type: application/json' --data-binary @"$BODY" | jq -r '.result')

# 5. Wait for the model (a build usually takes 3-7 minutes)
poll build "$BUILD_ID"

# 6. Download the artifacts. These are signed URLs: no Authorization header,
#    and they stay valid for 3 days after the task finishes.
TASK=$(api GET "$BASE/build/$BUILD_ID")
curl --silent --show-error --fail --max-time 900 \
  -o keycap.glb "$(jq -r '.model_urls.glb' <<<"$TASK")"
curl --silent --show-error --fail --max-time 900 \
  -o keycap-obj.zip "$(jq -r '.model_urls.obj_zip' <<<"$TASK")"
echo "Done: keycap.glb + keycap-obj.zip"
```

--------------------------------

### JavaScript: List Retexture Tasks

Source: https://docs.meshy.ai/en/api/retexture

Use this JavaScript example to list Retexture tasks using axios. It sends a GET request with an Authorization header and logs the response data. Errors are caught and logged.

```javascript
import axios from 'axios'

const headers = { Authorization: `Bearer ${YOUR_API_KEY}` };

try {
 const response = await axios.get(
   `https://api.meshy.ai/openapi/v1/retexture?page_size=10`,
   { headers }
 );
 console.log(response.data);
} catch (error) {
 console.error(error);
}
```

--------------------------------

### Create animation with Python (requests POST /openapi/v1/animations)

Source: https://docs.meshy.ai/en/api/animation

Use this Python example with the requests library to create animations from a rigged model. It covers a single preset action, multiple preset actions (action_ids) that produce one file with one clip per action, and post-processing to change FPS. Replace YOUR_API_KEY with your actual API key.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Animate a rigged model with required params only
payload = {
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/animations",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())

# Apply several preset actions and get one file with one clip per action
multi_action_payload = {
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_ids": [10, 25, 92]
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/animations",
    headers=headers,
    json=multi_action_payload,
)
response.raise_for_status()
print(response.json())

# With post-processing to change FPS
advanced_payload = {
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92,
    "post_process": {
        "operation_type": "change_fps",
        "fps": 24
    }
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/animations",
    headers=headers,
    json=advanced_payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### Python (requests): Basic and Quad Remesh Requests

Source: https://docs.meshy.ai/en/api/remesh

Python example using the requests library. It shows a basic remesh with custom formats and resize, followed by a quad remesh with auto-size. Requires an API key and the requests library.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Basic remesh with custom formats and resize
payload = {
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "resize_height": 1.0,
    "origin_at": "bottom"
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/remesh",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())

# Quad remesh with auto-size
auto_size_payload = {
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["glb", "fbx"],
    "topology": "quad",
    "target_polycount": 50000,
    "auto_size": True
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/remesh",
    headers=headers,
    json=auto_size_payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### JSON Response: Animation Task Object

Source: https://docs.meshy.ai/en/api/animation

Example response from the GET /openapi/v1/animations/:id endpoint. Shows the structure of the Animation Task object, including status, timestamps, consumed credits, and result URLs.

```json
{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.glb?Expires=...",
    "animation_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.fbx?Expires=...",
    "processed_usdz_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed.usdz?Expires=...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_armature.fbx?Expires=...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_60fps.fbx?Expires=..."
  },
  "preceding_tasks": 0
}
```

--------------------------------

### Create Image to 3D task with requests (simple and advanced)

Source: https://docs.meshy.ai/en/api/image-to-3d

Python example using requests to create an Image to 3D task. Shows a simple request with only image_url and an advanced request with meshy-7.1, 4K geometry, PBR, remesh, and A-pose. Requires YOUR_API_KEY and a publicly accessible image URL or base64 data URI.

```python
import requests

headers = {
    "Authorization": f"Bearer {YOUR_API_KEY}"
}

# Simple request with required params
payload = {
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/image-to-3d",
    headers=headers,
    json=payload,
)
response.raise_for_status()
print(response.json())

# With Ultra 4K geometry, remesh, PBR, and A-pose
advanced_payload = {
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "enable_pbr": True,
    "should_remesh": True,
    "target_polycount": 100000,
    "should_texture": True,
    "pose_mode": "a-pose",
    "target_formats": ["glb"],
}

response = requests.post(
    "https://api.meshy.ai/openapi/v1/image-to-3d",
    headers=headers,
    json=advanced_payload,
)
response.raise_for_status()
print(response.json())
```

--------------------------------

### JavaScript (axios): List prototype tasks

Source: https://docs.meshy.ai/en/api/creative-lab-fridge-magnet

Use this JavaScript example with axios to list prototype tasks. It sends a GET request to the /prototype endpoint with page_size=10 and logs the response. Requires an API key.

```javascript
import axios from 'axios'

const headers = { Authorization: `Bearer ${YOUR_API_KEY}` }

try {
  const { data } = await axios.get(
    'https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype',
    { headers, params: { page_size: 10 } }
  )
  console.log(data)
} catch (error) {
  console.error(error)
}
```
Tokens:
Raw