Expand description
§tripo-api
Unofficial async Rust client for the Tripo 3D Generation API.
§Usage
use tripo_api::{Client, TaskRequest, TextToModelRequest, WaitOptions};
let client = Client::new()?; // reads TRIPO_API_KEY
let id = client.create_task(TaskRequest::TextToModel(TextToModelRequest {
prompt: "a red robot".into(),
..Default::default()
})).await?;
let task = client.wait_for_task(&id, WaitOptions::default()).await?;
client.download_task_models(&task, std::path::Path::new("./out"), Default::default()).await?;§Features
schemars(default off): deriveschemars::JsonSchemaon public types.
§License
MIT Async Rust client for the Tripo 3D Generation API.
§Features
schemars(default off): deriveschemars::JsonSchemaon public types sotripo-mcpcan expose them as MCP tool schemas.
Re-exports§
pub use enums::Animation;pub use enums::ExportOrientation;pub use enums::FbxPreset;pub use enums::GeometryQuality;pub use enums::Orientation;pub use enums::OutputFormat;pub use enums::PostStyle;pub use enums::RigOutputFormat;pub use enums::RigSpec;pub use enums::RigType;pub use enums::RigTypeResponse;pub use enums::TextureAlignment;pub use enums::TextureFormat;pub use enums::TextureQuality;pub use tasks::AnimationInput;pub use tasks::CheckRiggableRequest;pub use tasks::ConvertModelRequest;pub use tasks::ImageToModelRequest;pub use tasks::MeshCompletionRequest;pub use tasks::MeshSegmentationRequest;pub use tasks::MultiviewToModelRequest;pub use tasks::RefineModelRequest;pub use tasks::RetargetAnimationRequest;pub use tasks::RigModelRequest;pub use tasks::SmartLowpolyRequest;pub use tasks::StylizeModelRequest;pub use tasks::TaskRequest;pub use tasks::TextToModelRequest;pub use tasks::TextureModelRequest;pub use tasks::TexturePrompt;pub use types::Balance;pub use types::Task;pub use types::TaskId;pub use types::TaskOutput;pub use types::TaskStatus;pub use types::UploadedFile;
Modules§
- enums
- Shared typed enums used across request and response structs.
- tasks
- Per-variant task request structs and the top-level
TaskRequestdispatch enum. - types
- Core data types exposed by the public API.
- versions
- Known
model_versionstring constants, grouped by the variant they apply to.
Structs§
- Client
- Async client for the Tripo 3D Generation API.
- Client
Builder - Builder for
Client. - Download
Options - Knobs for
download_task_models. - Downloaded
Files - Paths of all successfully downloaded files.
- Retry
Policy - Controls retry behavior.
- Wait
Options - Options for
Client::wait_for_task.
Enums§
- Compression
Mode - Compression options. Currently the server only supports
Geometry. - Error
- Errors returned by the client.
- Image
Input - A reference to an image, accepted by all image-consuming variants.
- Output
Kind - Which outputs to consider.
- Region
- Region selector.
Constants§
- API_
KEY_ ENV - Env var name for the API key.
- BASE_
URL_ CN - China mainland v2 openapi base URL.
- BASE_
URL_ GLOBAL - Global v2 openapi base URL.
- REGION_
ENV - Env var name for the region selector (
global|cn).
Type Aliases§
- Progress
Callback - Callback invoked after each successful poll.
- Result
- Result alias using
Error.