Struct Client 

pub struct Client { /* private fields */ }

Async client for the Tripo 3D Generation API.

Implementations

impl Client

pub fn new() -> Result<Self>

Read TRIPO_API_KEY (and optionally TRIPO_REGION) from the environment.

pub fn builder() -> ClientBuilder

Start a ClientBuilder.

pub fn with_api_key(key: impl Into<String>) -> Result<Self>

Construct with an explicit key, using defaults for everything else.

pub fn with_base_url(self, url: Url) -> Self

Override the base URL (testing or staging).

pub fn base_url(&self) -> &Url

Current base URL.

pub fn region(&self) -> Region

Current region.

pub async fn get_balance(&self) -> Result<Balance>

GET /user/balance — current account balance.

pub async fn get_task(&self, id: &TaskId) -> Result<Task>

GET /task/{id} — current state of an existing task.

pub async fn create_task(&self, req: TaskRequest) -> Result<TaskId>

POST /task — submit a task. Any ImageInput::Path in the request is uploaded first and replaced with a FileToken.

pub async fn create_task_raw(&self, body: &Value) -> Result<TaskId>

Submit an already-built JSON body to /task. Used by create_task and the CLI’s task create --json <FILE> escape hatch.

impl Client

pub async fn download_task_models( &self, task: &Task, dir: &Path, opts: DownloadOptions, ) -> Result<DownloadedFiles>

Download all available outputs of a task into dir. Creates dir if it does not exist. Atomic writes via .partial + rename.

impl Client

pub async fn upload_file(&self, path: impl AsRef<Path>) -> Result<UploadedFile>

Upload a local file and return a token usable as ImageInput::FileToken.

impl Client

pub async fn wait_for_task( &self, id: &TaskId, opts: WaitOptions, ) -> Result<Task>

Poll GET /task/{id} until the status is terminal or opts.timeout is reached.

Returns the final Task even for non-success terminal statuses; callers can check task.status. Use Error::WaitTimeout if you want an error on timeout (returned here).

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.