meshy

Documentation

Overview

Package meshy implements engine.Engine for the Meshy 3D model generation API.

Both text-to-3D and image-to-3D are async: POST /openapi/v2/text-to-3d or /openapi/v2/image-to-3d creates a task, GET /openapi/v2/text-to-3d/{id} or /openapi/v2/image-to-3d/{id} polls for completion. Auth: Authorization: Bearer {key}, env MESHY_API_KEY.

Index

• Variables
• func ConfigSchema() []engine.ConfigField
• func DefaultProvider() engine.Provider
• func ModelInfos() []engine.ModelInfo
• func ModelsByCapability() map[string][]string
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Capabilities() engine.Capability
  • func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)
  • func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Variables

var ErrMissingPrompt = fmt.Errorf("meshy: missing prompt in workflow graph")

Functions

func ConfigSchema

func ConfigSchema() []engine.ConfigField

ConfigSchema returns the configuration fields required by the Meshy engine.

func DefaultProvider

func DefaultProvider() engine.Provider

DefaultProvider returns preset engine configurations for meshy.

func ModelInfos

func ModelInfos() []engine.ModelInfo

ModelInfos returns i18n metadata for all Meshy models.

func ModelsByCapability

func ModelsByCapability() map[string][]string

ModelsByCapability returns all known Meshy capabilities grouped by type.

Types

type Config

type Config struct {
	APIKey            string
	BaseURL           string
	Endpoint          string // "text-to-3d" or "image-to-3d"
	HTTPClient        *http.Client
	WaitForCompletion bool
	PollInterval      time.Duration
	OnProgress        epoll.OnProgress
}

Config configures the Meshy engine.

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine implements engine.Engine for Meshy.

func New

func New(cfg Config) *Engine

New creates a Meshy engine instance.

func (*Engine) Capabilities

func (e *Engine) Capabilities() engine.Capability

Capabilities implements engine.Describer.

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)

Execute generates a 3D model via the Meshy API.

func (*Engine) Resume

func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Resume implements engine.Resumer -- resumes polling a previously submitted task.