TRIVERSE Docs

Introduction

Welcome to the Triverse API! Our API provides a powerful set of tools for developers to integrate 3D generative AI capabilities into their own applications. With Triverse, you can programmatically manage user accounts, upload assets, and create high-quality 3D models from images or text.

Overview

The Triverse API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All API requests should be made to the following base URL:

https://api.triverse.ai/api/v1

Note: This documentation covers the /api/v1 endpoints. Other prefixes like /platform are not included here.

Key Features

  • Image to 3D: Transform single reference images into detailed 3D meshes and textured models.
  • Text to 3D: Generate 3D assets directly from natural language descriptions.
  • Texturing: Apply high-quality textures to existing geometry using images or text prompts.
  • Model Utilities: Perform remeshing, format conversion, and multi-angle preview rendering.
  • Real-time Updates: Monitor task progress via WebSockets for a seamless user experience.

Response Format

Unless otherwise noted, all request and response bodies are in JSON format using UTF-8 encoding.

Standard Success Response

Successful API calls (HTTP 200 OK) return a standard structure:

FieldTypeDescription
codeIntegerStatus code, 0 indicates success.
messageStringDescription message, typically "success".
dataObjectThe actual response data, varying by endpoint.

Standard Error Response

When a request fails (HTTP 4xx or 5xx), the response body includes error details:

FieldTypeDescription
codeIntegerInternal error code for precise identification.
messageStringA concise description of the error.
suggestionString(Optional) Advice on how to resolve the error.

Common Data Structures

For detailed information on common response payloads such as TaskCreationResponsePayload, FlowStatusPayload, and DownloadResponse, please refer to the Common Response Structures document.

Next Steps

To start building with Triverse, check out our Authentication guide to set up your API key, or dive straight into the API Endpoints to explore available features.

On this page