Capture Metadata

Use this endpoint to retrieve detailed metadata for a specific capture.

The response contains camera poses, CDN URLs for the reconstructed 3D model files, and other useful attributes describing the capture’s geometry and reconstruction output.

You can also use the optional quality and profiles query parameters to specify which model variant you want to download.

Endpoint#

GET /share/SID/metadata

Replace SID with the share identifier (sid) of the capture you wish to query. You can obtain the sid from the capture listing.

Parameters#

Parameter	Type	Description	Values
`quality`	string	(Optional) Selects the model quality level to retrieve.	`sd` or `hd`
`lod`	boolean	(Optional) Toggle the Level of detail hierarchy	`true` or `false`
`use_cdn`	boolean	(Optional) Toggle the use of CDN urls	`true` or `false`
`profiles`	array of strings	(Optional) Specifies which output formats to include in the response.	see below

The profiles list may contain one or more of the following values:

Profile	Description
`ply`	Uncompressed, full-resolution `.ply` model file containing the complete 3D reconstruction. This format preserves the highest fidelity but results in large file sizes. Ideal for offline processing, analysis, or custom rendering pipelines that support `.ply` meshes directly.
`sogs-sh0`	Compressed model using the Self-Organizing Gaussian Splatting (SOGS) method. The returned URL points to a `.zip` archive containing six data files (`.bin` and `.json`), which together describe the splat-based representation. Best for efficient streaming and real-time visualization where quality and size must be balanced.
`fragment-chunk1`	Fragmented version of the reconstruction split into one or more smaller chunks. Each chunk is optimized for tiled or incremental loading in 3D applications. This profile offers moderate compression and faster access times for partial loading scenarios.
`fragment-float16`	Similar to `fragment-chunk1`, but uses 16-bit floating-point precision for storage. This reduces file size further at a small cost to numerical precision, making it suitable for lightweight devices or when bandwidth is limited.
`fragment-chunk1-sh0`	A variant of the fragmented format that applies SH0 (spherical harmonics order 0) lighting coefficients. Provides compact files optimized for real-time lighting and rendering consistency across different environments.
`ksplat-compress0`	First-generation Kernel Splatting format using baseline compression. Produces smaller files than `ply` while maintaining good quality. Recommended for general use cases and visualization pipelines already supporting ksplat models.
`ksplat-v2-compress0`	Version 2 of the Kernel Splatting format with updated data encoding and improved GPU compatibility. Uses minimal compression for fast decompression and higher visual fidelity.
`ksplat-v2-compress1`	Same as `ksplat-v2-compress0` but applies stronger compression to reduce file size. Ideal for cloud storage or web distribution where download speed matters more than minor quality loss.
`ksplat-v2-compress2`	The highest compression level of the V2 ksplat format. Generates the smallest files with minimal visual degradation. Recommended for quick previews, large-scale dataset sharing, or mobile visualization.

💡 Tip: You can request multiple profiles at once using a comma-separated list, for example:
curl -X GET "https://teleport.varjo.com/share/SID/metadata?profiles=fragment-chunk1&profiles=fragment-float16&profiles=ply"
The response will include URLs for all matching output formats.

Example Request#

curl -X GET "https://teleport.varjo.com/share/SID/metadata?profiles=fragment-chunk1&profiles=fragment-float16&profiles=ply&lod=true"

Example Response#

{
  "eid": "7dsa8dsa28ad",
  "sid": "3f417d8s82d484236ab911f160c738ebd",
  "name": "My Capture",
  "segmented_capture_eid": "mnfgkhvlhdt4",
  "profile_name": "fragment-chunk1",
  "lod": true,
  "hdr_mode": null,
  "nominal_ev": null,
  "tmo_parameters": null,
  "model_urls": [
    "https://6das98dsa8das.cloudfront.net/api-captures-production/7dsa8dsa28ad/..."
  ],
  "cameras": [
    {
      "matrix": [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, -1, 0, 0, 0, 0, 1]
    }
  ],
  "models": [
    {
      "url": "https://6das98dsa8das.cloudfront.net/api-captures-production/7dsa8dsa28ad/...",
      "size": 2132114,
      "id": null,
      "aabb": null,
      "resolution_range": null,
      "parent": null
    }
  ],
  "video_trajectory": null,
  "reposition_data": {
    "rotation_x": 0,
    "rotation_y": 0,
    "rotation_z": -0.707106781186548,
    "rotation_w": 0.707106781186548,
    "scale": 1
  }
}

Response Details#

profile_name - Indicates which output profile this metadata describes (for example, ply or sogs-sh0).
model_urls - CDN links for downloading the generated 3D models.
cameras - List of camera pose matrices used during the reconstruction.
models - Metadata about each generated model file, including size and bounding box (if available).
reposition_data - Transform information (rotation and scale) for positioning the model correctly in 3D space.

💡 Tip: You can use the returned model_urls to directly download the model files from the CDN, or integrate them into your 3D visualization pipeline.