Tripo H3.1 API

Complete API reference for Tripo H3.1 3D generation models by Tripo3D AI.

Model Variants

Model	Description
`tripo3d-h3.1-text-to-3d`	Generate a 3D model from a text description
`tripo3d-h3.1-image-to-3d`	Generate a 3D model from a single image
`tripo3d-h3.1-multiview-to-3d`	Generate a 3D model from multiple view images

Endpoints

text
POST /api/v1/3d/task
GET /api/v1/3d/{task_id}

Tripo H3.1 Text to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-text-to-3d`
`prompt`	string	Text description of the 3D model to generate

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`negative_prompt`	string	-	Maximum 1024 characters	Content to exclude from the generated result
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-text-to-3d',
    prompt: 'A cute cartoon robot with a round head',
    negative_prompt: 'blurry, deformed, extra limbs',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Tripo H3.1 Image to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-image-to-3d`
`image_url`	string	URL of the single input image

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`texture_alignment`	string	`original_image`	`original_image`, `geometry`	Texture alignment method
`orientation`	string	`default`	`default`, `align_image`	Generated model orientation
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-image-to-3d',
    image_url: 'https://example.com/object.png',
    texture_alignment: 'original_image',
    orientation: 'default',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Tripo H3.1 Multiview to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-multiview-to-3d`
`images`	string[]	Input image URLs in front, left, back, right order. At least two images are required

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`texture_alignment`	string	`original_image`	`original_image`, `geometry`	Texture alignment method
`orientation`	string	`default`	`default`, `align_image`	Generated model orientation
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-multiview-to-3d',
    images: [
      'https://example.com/front.png',
      'https://example.com/left.png',
      'https://example.com/back.png',
      'https://example.com/right.png',
    ],
    texture_alignment: 'original_image',
    orientation: 'default',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Response Format

Task Submission

json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "response_url": "https://api.flaq.ai/api/v1/3d/e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "task_status": "submitted"
  }
}

Query Task Status

javascript
const taskId = 'e1688c0c-1a28-47e1-a638-34f04b70e9c0';

const response = await fetch(`https://api.flaq.ai/api/v1/3d/${taskId}`, {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
  },
});

const result = await response.json();
console.log(result.data.task_status);

Completed Task

json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "response_url": "https://api.flaq.ai/api/v1/3d/e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "task_status": "succeed",
    "task_status_msg": null,
    "task_result": {
      "credit": 200,
      "files": [
        {
          "url": "https://example.com/generated-model.glb"
        }
      ]
    }
  }
}

Task Status Values

submitted: The task has been submitted
processing: The task is being processed
succeed: The task completed successfully
failed: The task failed

Tripo H3.1 API

Complete API reference for Tripo H3.1 3D generation models by Tripo3D AI.

Model Variants

Model	Description
`tripo3d-h3.1-text-to-3d`	Generate a 3D model from a text description
`tripo3d-h3.1-image-to-3d`	Generate a 3D model from a single image
`tripo3d-h3.1-multiview-to-3d`	Generate a 3D model from multiple view images

Endpoints

text
POST /api/v1/3d/task
GET /api/v1/3d/{task_id}

Tripo H3.1 Text to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-text-to-3d`
`prompt`	string	Text description of the 3D model to generate

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`negative_prompt`	string	-	Maximum 1024 characters	Content to exclude from the generated result
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-text-to-3d',
    prompt: 'A cute cartoon robot with a round head',
    negative_prompt: 'blurry, deformed, extra limbs',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Tripo H3.1 Image to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-image-to-3d`
`image_url`	string	URL of the single input image

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`texture_alignment`	string	`original_image`	`original_image`, `geometry`	Texture alignment method
`orientation`	string	`default`	`default`, `align_image`	Generated model orientation
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-image-to-3d',
    image_url: 'https://example.com/object.png',
    texture_alignment: 'original_image',
    orientation: 'default',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Tripo H3.1 Multiview to 3D

Required Parameters

Parameter	Type	Description
`model_name`	string	Must be `tripo3d-h3.1-multiview-to-3d`
`images`	string[]	Input image URLs in front, left, back, right order. At least two images are required

Optional Parameters

Parameter	Type	Default	Options / Range	Description
`texture_alignment`	string	`original_image`	`original_image`, `geometry`	Texture alignment method
`orientation`	string	`default`	`default`, `align_image`	Generated model orientation
`texture`	boolean	`true`	`true`, `false`	Whether to generate textures
`pbr`	boolean	Same as `texture`	`true`, `false`	Whether to generate PBR materials. Cannot be `true` when `texture` is `false`
`texture_quality`	string	`standard`	`standard`, `detailed`	Texture quality
`geometry_quality`	string	`standard`	`standard`, `detailed`	Geometry quality
`auto_size`	boolean	`false`	`true`, `false`	Whether to automatically scale the model to real-world dimensions
`quad`	boolean	`false`	`true`, `false`	Whether to generate a quad mesh

Example Request

javascript
const response = await fetch('https://api.flaq.ai/api/v1/3d/task', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    model_name: 'tripo3d-h3.1-multiview-to-3d',
    images: [
      'https://example.com/front.png',
      'https://example.com/left.png',
      'https://example.com/back.png',
      'https://example.com/right.png',
    ],
    texture_alignment: 'original_image',
    orientation: 'default',
    texture: true,
    pbr: true,
    texture_quality: 'standard',
    geometry_quality: 'standard',
    auto_size: false,
    quad: false,
  }),
});

const result = await response.json();
console.log(result.data.task_id);

Response Format

Task Submission

json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "response_url": "https://api.flaq.ai/api/v1/3d/e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "task_status": "submitted"
  }
}

Query Task Status

javascript
const taskId = 'e1688c0c-1a28-47e1-a638-34f04b70e9c0';

const response = await fetch(`https://api.flaq.ai/api/v1/3d/${taskId}`, {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
  },
});

const result = await response.json();
console.log(result.data.task_status);

Completed Task

json
{
  "code": 0,
  "message": "success",
  "data": {
    "task_id": "e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "response_url": "https://api.flaq.ai/api/v1/3d/e1688c0c-1a28-47e1-a638-34f04b70e9c0",
    "task_status": "succeed",
    "task_status_msg": null,
    "task_result": {
      "credit": 200,
      "files": [
        {
          "url": "https://example.com/generated-model.glb"
        }
      ]
    }
  }
}

Task Status Values

submitted: The task has been submitted
processing: The task is being processed
succeed: The task completed successfully
failed: The task failed