Ang Retexture API ay isang tampok na nagbibigay-daan sa iyo na isama ang AI retexturing capabilities ng Meshy sa iyong sariling aplikasyon. Sa seksyong ito, makikita mo ang lahat ng impormasyong kailangan mo upang makapagsimula sa API na ito.
Ang endpoint na ito ay nagbibigay-daan sa iyo na gumawa ng bagong Retexture task. Sumangguni sa
The Retexture Task Object upang makita kung anong mga
property ang kasama sa Retexture task object.
Mga Parameter
Isa lamang sa input_task_id o model_url ang kinakailangan. Kung parehong ibinigay, ang input_task_id ang mangunguna sa priority.
Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng nakumpletong Image to 3D o Text to 3D task na nais mong i-retexture.
Ang task na ito ay dapat isa sa mga sumusunod na task: Text to 3D Preview, Text to 3D Refine, Image to 3D o Remesh. Bukod dito, dapat itong may status na SUCCEEDED.
Name
model_url
Type
string
Kinakailangan
Description
Magbigay ng 3D model para i-texture ng Meshy. Mga suportadong format: .glb, .gltf, .obj, .fbx, .stl.
May dalawang paraan upang magbigay ng model:
Publicly accessible URL: Isang URL na maa-access mula sa publikong internet.
Data URI: Isang base64-encoded na data URI ng model. Gumamit ng MIME type na application/octet-stream. Halimbawa: data:application/octet-stream;base64,<your base64-encoded model data>.
Eksaktong isang style input ang kinakailangan: text_style_prompt, image_style_url, o multiview_image_urls. Ang multiview_image_urls ay hindi maaaring pagsamahin sa alinman sa dalawang iba pa; kung parehong ibinigay ang text_style_prompt at image_style_url, ang image_style_url ang mangunguna sa priority.
Name
text_style_prompt
Type
string
Kinakailangan
Description
Ilarawan ang gusto mong texture style ng object gamit ang text. Maximum na 800 characters.
Name
image_style_url
Type
string
Kinakailangan
Description
Magbigay ng 2d na larawan upang gabayan ang proseso ng pag-texture. Kasalukuyan naming suportado ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan upang magbigay ng larawan:
Publicly accessible URL: Isang URL na maa-access mula sa publikong internet
Data URI: Isang base64-encoded na data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Maaaring hindi gumana nang optimal ang image texturing kung may malalaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na larawan.
Name
multiview_image_urls
Type
string[]
Kinakailangan
Description
Magbigay ng 1 hanggang 4 na larawan na nagpapakita ng parehong object mula sa iba't ibang view upang gabayan ang pag-texture. Ang unang larawan ang siyang pangunahing (front) view; hindi mahalaga ang pagkakasunod-sunod ng natitirang mga view (left, back, right).
Ang bawat elemento ay tumatanggap ng parehong mga format tulad ng image_style_url (isang publicly accessible URL o isang base64 data URI, .jpg/.jpeg/.png).
Nangangailangan ng tahasang ai_model: "meshy-7".
Name
ai_model
Type
string
default latest
Description
ID ng AI model na gagamitin para sa retexturing. Mga available na value: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
default false
Description
Panatilihin ang umiiral na UV layout ng model sa halip na gumawa ng bago.
Kung nire-retexture mo ang isang model na ginawa ng Meshy (sa pamamagitan ng input_task_id, o isang model_url na nakaturo sa output ng Meshy), itakda ito sa true upang muling gamitin ang na-optimize nitong UV layout.
Kung nire-retexture mo ang isang third-party model na na-upload mo, itakda sa true kapag mayroon na itong magandang UV na gusto mong panatilihin, o iwanan itong false upang hayaan ang Meshy na mag-unwrap ng bagong UV (pinakamainam para sa mga model na kulang sa tamang UV mapping).
Name
enable_pbr
Type
boolean
default false
Description
Bumuo ng PBR maps (metallic, roughness, normal) bilang karagdagan sa base color. Kasama rin ang isang emission map kapag ang ai_model ay meshy-6, maliban sa texture_resolution: 8k. Hindi bumubuo ng emission map ang meshy-7 at latest.
Name
texture_resolution
Type
string
default 2k
Description
Resolution ng base color texture. Isa sa 2k (2048×2048), 4k (4096×4096), o 8k (8192×8192). Ang mas mataas na resolution ay nagkukuha ng mas maraming detalye ng ibabaw.
Ang 4k at 8k ay nangangailangan ng ai_model na meshy-6, meshy-7 o latest. Sa 8k, walang emission map na ginagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag parehong itinakda, ang texture_resolution ang mangunguna.
Name
remove_lighting
Type
boolean
default true
Description
Inaalis ang mga highlight at anino mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas mahusay gumana sa ilalim ng custom na lighting setup.
Suportado lamang kapag ang ai_model ay meshy-6.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Ang mga hiniling na format lamang ang bubuuin at ibabalik, na maaaring magpaikli sa oras ng pagkumpleto ng task. Kapag hindi ibinigay, kasama ang lahat ng suportadong format.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi ibinigay, lahat ng format maliban sa 3mf ang bubuuin. Ang 3mf ay isinasama lamang kapag tahasang tinukoy.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay bukod pa dito magre-render ng transparent-background (RGBA) na bersyon ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang umiiral na field na thumbnail_url.
Mga Ibinabalik
Ang result property ng response ay naglalaman ng task id ng bagong ginawang Retexture task.
Mga Failure Mode
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:
Kulang na parameter: Dapat ibigay ang model_url o input_task_id.
Kulang na style: Dapat ibigay ang isa sa text_style_prompt, image_style_url o multiview_image_urls.
Nagkakasalungat na style input: Ang multiview_image_urls ay hindi maaaring pagsamahin sa text_style_prompt o image_style_url.
Hindi suportadong model para sa multi-view: Ang multiview_image_urls ay nangangailangan ng tahasang ai_model: "meshy-7".
Hindi available ang model: Ang ai_model: "meshy-7" ay unti-unting inilulunsad at hindi pa naka-enable para sa iyong account.
Hindi valid na input task: Ang input_task_id ay dapat tumukoy sa isang matagumpay na task mula sa isang suportadong model.
Hindi valid na format ng model: Ang model_url ay tumuturo sa isang file na may hindi suportadong extension.
Hindi maabot na URL: Ang model_url, image_style_url o isang elemento ng multiview_image_urls ay hindi ma-download.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits upang gawin ang task na ito.
Name
429 - Too Many Requests
Description
Nalampasan mo na ang iyong rate limit.
Request
POST
/openapi/v1/retexture
# Retexture with text promptcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style", "enable_original_uv": true, "enable_pbr": true }'# Retexture with image style and PBRcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "image_style_url": "https://cdn.meshy.ai/image/example_image.jpg", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang Retexture task gamit ang isang wastong task id.
Sumangguni sa The Retexture Task Object upang makita kung aling
mga katangian ang kasama sa Retexture task object.
Mga Parameter
Name
id
Type
path
Description
Natatanging pagkakakilanlan para sa Retexture task na kukunin.
Mga Ibinabalik
Ang tugon ay naglalaman ng Retexture task object. Suriin ang
The Retexture Task Object na seksyon para sa mga detalye.
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","texture_image_url":"","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" } ],"task_error": {"message":"" },"consumed_credits":10}
Ang endpoint na ito ay permanenteng bumubura ng isang retexture task, kasama ang lahat ng kaugnay na modelo at datos. Ang aksyong ito ay hindi na mababawi.
[ {"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***","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=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","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":10 }]
Ang Objek ng Retexture Task ay isang yunit ng trabaho na ginagamit ng Meshy upang makabuo ng isang 3D texture mula sa alinman sa text o image inputs. Ang modelo ay may mga sumusunod na katangian:
Mga Katangian
Name
id
Type
string
Description
Natatanging tagapagkilala para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang mga pagpapalagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng Retexture task. Ang halaga ay retexture.
Name
model_urls
Type
object
Description
Downloadable URL sa textured 3D model file na nabuo ng Meshy.
Name
glb
Type
string
Description
Downloadable URL sa GLB file.
Name
fbx
Type
string
Description
Downloadable URL sa FBX file.
Name
obj
Type
string
Description
Downloadable URL sa OBJ file.
Name
usdz
Type
string
Description
Downloadable URL sa USDZ file.
Name
mtl
Type
string
Description
Downloadable URL sa MTL file, ibinabalik kasabay ng OBJ exports kapag may mga texture.
Name
stl
Type
string
Description
Downloadable URL sa STL file.
Name
3mf
Type
string
Description
Downloadable URL sa 3MF file. Tanging naroroon kapag ang 3mf ay hiniling sa pamamagitan ng target_formats.
Name
text_style_prompt
Type
string
Description
Ito ang text prompt na ginamit upang lumikha ng texturing task.
Name
image_style_url
Type
string
Description
Ito ang image input na ginamit upang lumikha ng texturing task.
Name
multiview_image_urls
Type
string[]
Description
Downloadable URLs sa multi-view reference images na ginamit upang lumikha ng texturing task. Tanging naroroon kapag ang gawain ay nilikha gamit ang multiview_image_urls.
Name
thumbnail_url
Type
string
Description
Downloadable URL sa thumbnail image ng model file.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL sa isang transparent-background (RGBA) na bersyon ng thumbnail_url. Tanging naroroon kapag ang gawain ay nilikha gamit ang alpha_thumbnail: true at ang transparent preview ay matagumpay na na-render; kung hindi, ang field na ito ay hindi kasama.
Name
progress
Type
integer
Description
Pag-unlad ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang gawain ay nagtagumpay, ito ay magiging 100.
Name
started_at
Type
timestamp
Description
Timestamp ng kung kailan sinimulan ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0.
Ang isang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, ayon sa
RFC 3339 na pamantayan.
Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop
sa lahat ng mga timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp ng kung kailan nilikha ang gawain, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp ng kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp ng kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang property na ito ay magiging 0.
Name
status
Type
string
Description
Status ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL objects na nabuo mula sa gawain. Karaniwan ito ay naglalaman lamang ng isang texture URL object. Ang bawat texture URL ay may mga sumusunod na katangian:
Name
base_color
Type
string
Description
Downloadable URL sa base color map image.
Name
metallic
Type
string
Description
Downloadable URL sa metallic map image.
Kung ang gawain ay nilikha gamit ang enable_pbr: false, ang property na ito ay hindi kasama.
Name
normal
Type
string
Description
Downloadable URL sa normal map image.
Kung ang gawain ay nilikha gamit ang enable_pbr: false, ang property na ito ay hindi kasama.
Name
roughness
Type
string
Description
Downloadable URL sa roughness map image.
Kung ang gawain ay nilikha gamit ang enable_pbr: false, ang property na ito ay hindi kasama.
Name
emission
Type
string
Description
Downloadable URL sa emission map image.
Kung ang gawain ay nilikha gamit ang enable_pbr: false, o ai_model ay meshy-5, ang property na ito ay hindi kasama.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain.
Ang property na ito ay tanging naroroon kapag ang status ng gawain ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng gawain na ito. Naroroon kapag ang status ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa FAILED na mga gawain (ang mga credits ay ibinabalik kapag nabigo).
Example Retexture Task Model
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***" },"text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","image_style_url":"https://assets.meshy.ai/***/image/example_image.jpg?Expires=***","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","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":10}