vendor_connectors.meshy.models
Pydantic models for Meshy API types.
Module Contents
Section titled “Module Contents”Classes
Section titled “Classes”TaskStatus | |
|---|---|
ArtStyle | Art style for text-to-3D generation. |
TexturePBRMapType | |
Text3DRequest | |
ModelUrls | |
TextureUrls | |
Text3DResult | |
Text3DTask | |
RiggingTask | |
AnimationTask | |
RetextureTask | |
AnimationAction | |
TextTextureRequest | |
TextTextureResult | |
Image3DRequest | |
Image3DResult | |
RiggingRequest | |
BasicAnimations | |
RiggingResultData | |
RiggingResult | |
AnimationRequest | |
AnimationResult | |
RetextureRequest | |
RetextureResult | |
AssetIntent | Categories for 3D asset generation. |
AssetSpec | High-level specification for 3D asset generation. |
class vendor_connectors.meshy.models.TaskStatus
Section titled “class vendor_connectors.meshy.models.TaskStatus”PENDING
Section titled “PENDING”‘PENDING’
IN_PROGRESS
Section titled “IN_PROGRESS”‘IN_PROGRESS’
SUCCEEDED
Section titled “SUCCEEDED”‘SUCCEEDED’
FAILED
Section titled “FAILED”‘FAILED’
EXPIRED
Section titled “EXPIRED”‘EXPIRED’
class vendor_connectors.meshy.models.ArtStyle
Section titled “class vendor_connectors.meshy.models.ArtStyle”Art style for text-to-3D generation.
Per Meshy API docs:
- realistic: Realistic style
- sculpture: Sculpture style (PBR not recommended but not enforced)
Initialization
Section titled “Initialization”Initialize self. See help(type(self)) for accurate signature.
REALISTIC
Section titled “REALISTIC”‘realistic’
SCULPTURE
Section titled “SCULPTURE”‘sculpture’
class vendor_connectors.meshy.models.TexturePBRMapType
Section titled “class vendor_connectors.meshy.models.TexturePBRMapType”BASE_COLOR
Section titled “BASE_COLOR”‘baseColor’
METALLIC
Section titled “METALLIC”‘metallic’
ROUGHNESS
Section titled “ROUGHNESS”‘roughness’
NORMAL
Section titled “NORMAL”‘normal’
‘ao’
class vendor_connectors.meshy.models.Text3DRequest
Section titled “class vendor_connectors.meshy.models.Text3DRequest”Bases: pydantic.BaseModel
‘Field(…)’
prompt : str
Section titled “prompt : str”None
art_style : vendor_connectors.meshy.models.ArtStyle
Section titled “art_style : vendor_connectors.meshy.models.ArtStyle”None
negative_prompt : str | None
Section titled “negative_prompt : str | None”None
ai_model : str | None
Section titled “ai_model : str | None”None
topology : str | None
Section titled “topology : str | None”None
target_polycount : int | None
Section titled “target_polycount : int | None”None
enable_pbr : bool | None
Section titled “enable_pbr : bool | None”None
class vendor_connectors.meshy.models.ModelUrls
Section titled “class vendor_connectors.meshy.models.ModelUrls”Bases: pydantic.BaseModel
None
None
None
None
None
class vendor_connectors.meshy.models.TextureUrls
Section titled “class vendor_connectors.meshy.models.TextureUrls”Bases: pydantic.BaseModel
base_color : str | None
Section titled “base_color : str | None”None
metallic : str | None
Section titled “metallic : str | None”None
roughness : str | None
Section titled “roughness : str | None”None
normal : str | None
Section titled “normal : str | None”None
None
class vendor_connectors.meshy.models.Text3DResult
Section titled “class vendor_connectors.meshy.models.Text3DResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
model_urls : vendor_connectors.meshy.models.ModelUrls | None
Section titled “model_urls : vendor_connectors.meshy.models.ModelUrls | None”None
texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None
Section titled “texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None”None
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.Text3DTask
Section titled “class vendor_connectors.meshy.models.Text3DTask”Bases: pydantic.BaseModel
task_id : str
Section titled “task_id : str”None
prompt : str =
Section titled “prompt : str = ”art_style : str =
Section titled “art_style : str = ”status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
model_urls : dict[str, str]
Section titled “model_urls : dict[str, str]”‘Field(…)’
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.RiggingTask
Section titled “class vendor_connectors.meshy.models.RiggingTask”Bases: pydantic.BaseModel
task_id : str
Section titled “task_id : str”None
model_id : str =
Section titled “model_id : str = ”status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
model_urls : dict[str, str]
Section titled “model_urls : dict[str, str]”‘Field(…)’
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.AnimationTask
Section titled “class vendor_connectors.meshy.models.AnimationTask”Bases: pydantic.BaseModel
task_id : str
Section titled “task_id : str”None
model_id : str =
Section titled “model_id : str = ”animation_id : str =
Section titled “animation_id : str = ”status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
video_url : str | None
Section titled “video_url : str | None”None
model_urls : dict[str, str]
Section titled “model_urls : dict[str, str]”‘Field(…)’
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.RetextureTask
Section titled “class vendor_connectors.meshy.models.RetextureTask”Bases: pydantic.BaseModel
task_id : str
Section titled “task_id : str”None
model_id : str =
Section titled “model_id : str = ”prompt : str =
Section titled “prompt : str = ”art_style : str =
Section titled “art_style : str = ”status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
model_urls : dict[str, str]
Section titled “model_urls : dict[str, str]”‘Field(…)’
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.AnimationAction
Section titled “class vendor_connectors.meshy.models.AnimationAction”Bases: pydantic.BaseModel
None
None
category : str =
Section titled “category : str = ”duration : float
Section titled “duration : float”0.0
preview_url : str | None
Section titled “preview_url : str | None”None
class vendor_connectors.meshy.models.TextTextureRequest
Section titled “class vendor_connectors.meshy.models.TextTextureRequest”Bases: pydantic.BaseModel
model_url : str
Section titled “model_url : str”None
prompt : str
Section titled “prompt : str”None
art_style : vendor_connectors.meshy.models.ArtStyle
Section titled “art_style : vendor_connectors.meshy.models.ArtStyle”None
negative_prompt : str | None
Section titled “negative_prompt : str | None”None
ai_model : str | None
Section titled “ai_model : str | None”None
resolution : str | None
Section titled “resolution : str | None”‘1024’
enable_pbr : bool | None
Section titled “enable_pbr : bool | None”True
class vendor_connectors.meshy.models.TextTextureResult
Section titled “class vendor_connectors.meshy.models.TextTextureResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None
Section titled “texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None”None
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.Image3DRequest
Section titled “class vendor_connectors.meshy.models.Image3DRequest”Bases: pydantic.BaseModel
‘Field(…)’
image_url : str
Section titled “image_url : str”None
ai_model : str | None
Section titled “ai_model : str | None”None
topology : str | None
Section titled “topology : str | None”None
target_polycount : int | None
Section titled “target_polycount : int | None”None
enable_pbr : bool | None
Section titled “enable_pbr : bool | None”None
class vendor_connectors.meshy.models.Image3DResult
Section titled “class vendor_connectors.meshy.models.Image3DResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
model_urls : vendor_connectors.meshy.models.ModelUrls | None
Section titled “model_urls : vendor_connectors.meshy.models.ModelUrls | None”None
texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None
Section titled “texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None”None
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
error : str | None
Section titled “error : str | None”None
class vendor_connectors.meshy.models.RiggingRequest
Section titled “class vendor_connectors.meshy.models.RiggingRequest”Bases: pydantic.BaseModel
input_task_id : str | None
Section titled “input_task_id : str | None”None
model_url : str | None
Section titled “model_url : str | None”None
height_meters : float
Section titled “height_meters : float”1.7
texture_image_url : str | None
Section titled “texture_image_url : str | None”None
class vendor_connectors.meshy.models.BasicAnimations
Section titled “class vendor_connectors.meshy.models.BasicAnimations”Bases: pydantic.BaseModel
walking_glb_url : str | None
Section titled “walking_glb_url : str | None”None
walking_fbx_url : str | None
Section titled “walking_fbx_url : str | None”None
walking_armature_glb_url : str | None
Section titled “walking_armature_glb_url : str | None”None
running_glb_url : str | None
Section titled “running_glb_url : str | None”None
running_fbx_url : str | None
Section titled “running_fbx_url : str | None”None
running_armature_glb_url : str | None
Section titled “running_armature_glb_url : str | None”None
class vendor_connectors.meshy.models.RiggingResultData
Section titled “class vendor_connectors.meshy.models.RiggingResultData”Bases: pydantic.BaseModel
rigged_character_fbx_url : str | None
Section titled “rigged_character_fbx_url : str | None”None
rigged_character_glb_url : str | None
Section titled “rigged_character_glb_url : str | None”None
basic_animations : vendor_connectors.meshy.models.BasicAnimations | None
Section titled “basic_animations : vendor_connectors.meshy.models.BasicAnimations | None”None
class vendor_connectors.meshy.models.RiggingResult
Section titled “class vendor_connectors.meshy.models.RiggingResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
expires_at : int | None
Section titled “expires_at : int | None”None
task_error : dict[str, Any] | None
Section titled “task_error : dict[str, Any] | None”None
result : vendor_connectors.meshy.models.RiggingResultData | None
Section titled “result : vendor_connectors.meshy.models.RiggingResultData | None”None
preceding_tasks : int
Section titled “preceding_tasks : int”0
class vendor_connectors.meshy.models.AnimationRequest
Section titled “class vendor_connectors.meshy.models.AnimationRequest”Bases: pydantic.BaseModel
rig_task_id : str
Section titled “rig_task_id : str”None
action_id : int
Section titled “action_id : int”None
True
frame_rate : int | None
Section titled “frame_rate : int | None”30
class vendor_connectors.meshy.models.AnimationResult
Section titled “class vendor_connectors.meshy.models.AnimationResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
expires_at : int | None
Section titled “expires_at : int | None”None
animation_glb_url : str | None
Section titled “animation_glb_url : str | None”None
animation_fbx_url : str | None
Section titled “animation_fbx_url : str | None”None
task_error : dict[str, Any] | None
Section titled “task_error : dict[str, Any] | None”None
preceding_tasks : int
Section titled “preceding_tasks : int”0
class vendor_connectors.meshy.models.RetextureRequest
Section titled “class vendor_connectors.meshy.models.RetextureRequest”Bases: pydantic.BaseModel
input_task_id : str | None
Section titled “input_task_id : str | None”None
model_url : str | None
Section titled “model_url : str | None”None
text_style_prompt : str | None
Section titled “text_style_prompt : str | None”None
image_style_url : str | None
Section titled “image_style_url : str | None”None
ai_model : str
Section titled “ai_model : str”‘latest’
enable_original_uv : bool
Section titled “enable_original_uv : bool”True
enable_pbr : bool
Section titled “enable_pbr : bool”False
class vendor_connectors.meshy.models.RetextureResult
Section titled “class vendor_connectors.meshy.models.RetextureResult”Bases: pydantic.BaseModel
None
status : vendor_connectors.meshy.models.TaskStatus
Section titled “status : vendor_connectors.meshy.models.TaskStatus”None
progress : int
Section titled “progress : int”0
created_at : int
Section titled “created_at : int”None
started_at : int | None
Section titled “started_at : int | None”None
finished_at : int | None
Section titled “finished_at : int | None”None
expires_at : int | None
Section titled “expires_at : int | None”None
model_urls : vendor_connectors.meshy.models.ModelUrls | None
Section titled “model_urls : vendor_connectors.meshy.models.ModelUrls | None”None
texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None
Section titled “texture_urls : list[vendor_connectors.meshy.models.TextureUrls] | None”None
thumbnail_url : str | None
Section titled “thumbnail_url : str | None”None
text_style_prompt : str | None
Section titled “text_style_prompt : str | None”None
image_style_url : str | None
Section titled “image_style_url : str | None”None
task_error : dict[str, Any] | None
Section titled “task_error : dict[str, Any] | None”None
preceding_tasks : int
Section titled “preceding_tasks : int”0
class vendor_connectors.meshy.models.AssetIntent
Section titled “class vendor_connectors.meshy.models.AssetIntent”Categories for 3D asset generation.
Initialization
Section titled “Initialization”Initialize self. See help(type(self)) for accurate signature.
PLAYER_CHARACTER
Section titled “PLAYER_CHARACTER”‘player_character’
NPC_CHARACTER
Section titled “NPC_CHARACTER”‘npc_character’
CREATURE_PREDATOR
Section titled “CREATURE_PREDATOR”‘creature_predator’
CREATURE_PREY
Section titled “CREATURE_PREY”‘creature_prey’
PROP_INTERACTABLE
Section titled “PROP_INTERACTABLE”‘prop_interactable’
PROP_DECORATION
Section titled “PROP_DECORATION”‘prop_decoration’
TERRAIN_ELEMENT
Section titled “TERRAIN_ELEMENT”‘terrain_element’
TEXTURE_TERRAIN
Section titled “TEXTURE_TERRAIN”‘texture_terrain’
TEXTURE_MATERIAL
Section titled “TEXTURE_MATERIAL”‘texture_material’
class vendor_connectors.meshy.models.AssetSpec
Section titled “class vendor_connectors.meshy.models.AssetSpec”Bases: pydantic.BaseModel
High-level specification for 3D asset generation.
intent : vendor_connectors.meshy.models.AssetIntent
Section titled “intent : vendor_connectors.meshy.models.AssetIntent”None
description : str
Section titled “description : str”None
art_style : vendor_connectors.meshy.models.ArtStyle
Section titled “art_style : vendor_connectors.meshy.models.ArtStyle”None
target_polycount : int | None
Section titled “target_polycount : int | None”None
enable_pbr : bool
Section titled “enable_pbr : bool”True
output_path : str
Section titled “output_path : str”‘Field(…)’
metadata : dict[str, Any]
Section titled “metadata : dict[str, Any]”‘Field(…)’
asset_id : str | None
Section titled “asset_id : str | None”‘Field(…)’