Splats

Get a splat owned by the authenticated caller

Returns a single splat owned by the authenticated user. Newly completed uploads may return status: "processing" until processing finishes.

get/v1/splats/{splatId}

Request

Base URL
https://playcanvas.com/api/supersplat
Auth
HTTP bearer
TypeScript
https://skmtc.dev/playcanvas/apis/supersplat-api/docs/v1/splats/:splatId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

splatIdstring required

Opaque public splat id.

Example:a1b2c3d4

Response

Splat

idstring required

Public 8-character splat id.

titlestring required

Display title.

descriptionstring required

Display description.

status'processing' | 'completed' | 'failed' required

Publish lifecycle state of the splat.

visibility'listed' | 'unlisted' required

Whether the splat is listed publicly or only reachable by direct link.

formatstring nullable required

Published output format once processing completes. null while processing.

sizeinteger required

Published splat size in bytes. Processing splats may report 0 until output is available.

viewerUrlstring required

URL where the splat can be viewed.

createdAtstring date-time nullable required

Creation timestamp.

updatedAtstring date-time nullable required

Last update timestamp.

completedAtstring date-time nullable required

Processing completion timestamp, or null while processing.

Example response

{
  "id": "a1b2c3d4",
  "title": "garden-scan",
  "status": "processing",
  "visibility": "unlisted",
  "viewerUrl": "https://superspl.at/scene/a1b2c3d4",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.