Get 3D Preview Mesh

Create a 3D mesh from an Image-to-3D session.

Request

POST https://api.csm.ai/image-to-3d-sessions/get-3d/preview/<Session Code>

Parameters

selected_spin_index type: number
in: body
default: 0
description: Specifies the index of the image to be used from the generated spins. Available values: 0, 1, 2, 3
Note: This parameter is required only if preview_mesh was set to turbo when creating the session initially.

selected_spin type: string
in: body
description: The URL of a specific image to be used from the generated spins.
Note: This parameter is required only if preview_mesh was set to turbo when creating the session initially.

scaled_bbox OPTIONAL
type: array
in: body
description: Defines the scaled bounding box for the asset's target dimensions. scaled_bbox should be a list of three float values representing width, height, and depth in that order.

pivot_point OPTIONAL
type: array
in: body
example: [0.0, 0.0, 0.0]
description: Sets the pivot point (origin) of the exported mesh. pivot_point is a list of three float values specifying the x, y, and z coordinates. Values should be in the range [-0.5, 0.5], normalized to the mesh's bounding box. Examples:

Center of bounding box: [0, 0, 0] (default)
Left-bottom-back corner: [-0.5, -0.5, -0.5]
Right-top-front corner: [0.5, 0.5, 0.5]
Center-bottom: [0, -0.5, 0]

Code Snippets

Python

import requests
import json
 
url = "https://api.csm.ai/image-to-3d-sessions/get-3d/preview/SESSION_P_44569824122"
 
payload = json.dumps({
  "selected_spin_index": 0,
  "selected_spin": "https://via.placeholder.com/300/09f/fff.png"
})
 
headers = {
  'x-api-key': '<X-API_KEY>',
  'Content-Type': 'application/json'
}
 
response = requests.request("POST", url, headers=headers, data=payload)
 
print(response.text)

Node.js

var request = require('request');
var options = {
  method: 'POST',
  url: 'https://api.csm.ai/image-to-3d-sessions/get-3d/preview/SESSION_P_44569824122',
  headers: {
    'x-api-key': '<X-API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "selected_spin_index": 0,
    "selected_spin": "https://via.placeholder.com/300/09f/fff.png"
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Curl

curl -k --location 'https://api.csm.ai/image-to-3d-sessions/get-3d/preview/SESSION_P_44569824122' \
--header 'x-api-key: <X-API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "selected_spin_index": 0,
    "selected_spin": "https://via.placeholder.com/300/09f/fff.png"
}'

Response

{
  "error": "",
  "message": "Generating Mesh",
  "statusCode": 200,
  "data": {
    "scenario": "SESSION_P_44569824122",
    "unique_trial_key": "168923176748ZJ@NcRfUjXn2r5u8x",
    "status": "unprocessed",
    "complete_job_data": {
      "scenario": "SESSION_P_44569824122",
      "job_priority": "2",
      "username": "admin@test.com",
      "call": "dreamfusion",
      "user_id": "000000",
      "status": "unprocessed",
      "start_time": "1689231769.6472576",
      "unique_trial_key": "168923176748ZJ@NcRfUjXn2r5u8x",
      "task_data": "{\"scenario\": \"SESSION_P_44569824122\", \"unique_trial_key\": \"168923176748ZJ@NcRfUjXn2r5u8x\", \"customer_email\": \"admin@yopmail.com\", \"image_url\": \"https://via.placeholder.com/300/09f/fff.png\", \"text_prompt\": \"Walk\", \"keyword\": \"\", \"discord_user_id\": \"\"}",
      "id": "job:dreamfusion:SESSION_P_44569824122_168923176748ZJ@NcRfUjXn2r5u8x"
    }
  }
}

Regenerate Spins Get 3D Refined Mesh