List User Sessions

Retrieve a list of Image-to-3D sessions for a user.

Request

GET https://api.csm.ai/image-to-3d-sessions

Parameters

limit OPTIONAL
type: string
in: query
default: 10
description: Specifies the number of records to be returned in the response.

page OPTIONAL
type: string
in: query
description: Defines the page of results by specifying the number of records to skip.

Code Snippets

Python

import requests
 
url = "https://api.csm.ai/image-to-3d-sessions?page=1"
 
payload = ""
headers = {
  'x-api-key': '<X-API_KEY>',
}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)

Node.js

var request = require('request');
var options = {
  method: 'GET',
  url: 'https://api.csm.ai/image-to-3d-sessions?page=1',
  headers: {
    'x-api-key': '<X-API_KEY>',
  }
};
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?page=1' \
--header 'x-api-key: <X-API_KEY>'

Response

{
  "error": "",
  "message": "Retrieved",
  "statusCode": 200,
  "data": {
    "results": [
      {
        "session_code": "SESSION_XXXXXXXXXX_XXXXXXX",
        "image_url": "https://via.placeholder.com/300/09f/fff.png",
        "manual_segmentation": false,
        "geometry_model": "turbo",
        "texture_model": "pbr",
        "topology": "tris",
        "resolution": "high_poly",
        "symmetry": "auto",
        "scaled_bbox": [-1, -1, -1],
        "preserve_aspect_ratio": false,
        "pivot_point": [0, 0, 0],
        "mesh_url": "https://via.placeholder.com/300/09f/mesh.zip",
        "mesh_url_obj": "https://via.placeholder.com/300/09f/mesh.obj",
        "mesh_url_zip": "https://via.placeholder.com/300/09f/mesh.zip",
        "mesh_url_glb": "https://via.placeholder.com/300/09f/mesh.glb",
        "mesh_url_fbx": "https://via.placeholder.com/300/09f/mesh.fbx",
        "mesh_url_usdz": "https://via.placeholder.com/300/09f/mesh.usdz",
        "mp4_url": "https://via.placeholder.com/300/09f/spin.mp4",
        "updated_at": "YYYY-MM-DDTHH:MM:SS.SSSZ",
        "created_at": "YYYY-MM-DDTHH:MM:SS.SSSZ",
        "session_status": "complete",
        "percent_done": 100
      },
      ...
    ],
    "page": 0,
    "skip": 0,
    "limit": 10,
    "totalPages": 1,
    "totalResults": 1,
    "credits": 20,
    "image_to_3d_credits": 0
  }
}

Get Session Create Session