TRIVERSE Docs
Getting Started

Changelog

All notable changes to the Triverse API will be documented in this file.

v1.1.6

Release Date: July 12, 2026

Added

  • Added POST /api/v1/tasks/image-to-artistic-mesh for API-key callers, including upload-to-generation usage, request parameters, fixed-price quoting, task polling, and asset download behavior.
  • Added /platform/generate/image-to-artistic-mesh for Web callers while retaining /platform/generate/image-to-smart-mesh as a compatibility alias.

v1.1.5

Release Date: June 11, 2026

Added

  • Added cost_credits to PublicTaskStatusPayload so API-key callers can see a task's credit cost when polling GET /api/v1/tasks/{task_uuid} or receiving WebSocket status frames.

v1.1.4

Release Date: June 3, 2026

Changed

  • Documented unified credit balance fields on GET /api/v1/users/me and GET /api/v1/users/balance: total_usable_credits, permanent_usable_credits, and total_frozen_credits.
  • Marked legacy balance fields such as balance, frozen, web_credits_balance, and api_credits_balance as compatibility fields while preserving them in responses.
  • Clarified that task pricing quote available_credits represents the unified available credit balance for API task creation.

v1.1.3

Release Date: June 2, 2026

Added

  • Added POST /api/v1/tasks/pricing/quote so API-key callers can check task cost_credits, current available_credits, and the normalized public quote params before creating a task.
  • Added a dedicated Pricing Quote API documentation page with supported quote parameters, per-flow examples, copied payload behavior, and error examples.

Changed

  • Normalized Web/API generation status surfaces to the public status enum, including mapping internal QUEUING to public QUEUED.
  • Clarified that API quote params only need price-affecting fields and that execution-only or internal fields are ignored.
  • Replaced Web own-models records with a public own-model item payload that preserves public request_payload inputs while hiding internal scheduler, pricing, analytics, audit, and provider fields. See the frontend integration guide for the PublicOwnModelItemPayload field contract.

v1.1.2

Release Date: May 27, 2026

Changed

  • Standardized generation task creation responses on PublicTaskCreationPayload with task_uuid, flow_name, status, created_at, cost_credits, and optional public queue hints.
  • Standardized task polling and WebSocket responses on PublicTaskStatusPayload with the public statuses PENDING, QUEUED, RUNNING, SUCCESS, FAILED, and CANCELLED.
  • Removed internal scheduler, worker, pricing manifest, analytics, tracking, and user-identifying fields from public generation responses and WebSocket frames.
  • Flattened generation API error responses to the top-level code, message, and optional suggestion shape.
  • Normalized unexpected generation task polling failures to the public 5005 task processing error envelope instead of a raw server error body.

v1.1.1

Release Date: May 8, 2026

Changed

  • Realigned API documentation with the current /api/v1 code.
  • Documented newly exposed endpoints: image-to-mesh-mv and prompt-optimize.
  • Refreshed WebSocket endpoint documentation and checker support.
  • Corrected parameters across upload, image-to-3D, text-to-3D, texturing, utilities, task status, and asset download docs.
  • Moved and confirmed the API documentation maintenance checker at scripts/docs/check_api_docs.py.

v1.1.0

Release Date: Jan 14, 2026

Added

  • New code examples for JavaScript and Python across all major endpoints.
  • Detailed documentation for WebSocket monitoring, including the "Catch-up" mechanism.

Changed

  • Aligned documentation with the latest /api/v1 implementation.
  • Updated WebSocket paths and authentication methods for better security and consistency.
  • Simplified asset download logic: consolidated into a single endpoint that handles both geometry and textures.

v1.0.0

Release Date: Dec 23, 2025

Added

  • Initial release of the Triverse API.
  • User Management: Query profile and credit balance.
  • File Uploads: Support for direct multipart uploads and presigned URL uploads.
  • Generation Tasks: Support for Image-to-3D, Text-to-3D, and Texturing workflows.
  • Task Monitoring: Real-time status updates via WebSockets.
  • Asset Management: Endpoints for retrieving and downloading generated 3D assets.

On this page