PLplaycanvas
Uploads

Get a resumable upload session

Returns upload session state and any parts already observed by the server. Use this to resume an interrupted upload.

get/v1/splats/uploads/{uploadId}

Request

Path parameters

uploadIdstring required

Opaque resumable upload session id.

Example:upl_0123456789abcdef01234567

Response

Upload session

idstring required

Resumable upload session id.

status'created' | 'uploading' | 'processing' | 'completed' | 'canceled' required

Lifecycle state of the resumable upload session. processing means the bytes have been committed and the splat is being finalized.

contentLengthinteger nullable required

Total source file size declared when creating the upload, or null when the client did not provide one.

sourceFormat'ply' | 'sog' | 'ssog' | 'lcc' required

Format of the file being uploaded. Use ply for raw Gaussian splat PLY files, sog for SOG files, ssog for SSOG archives exported by SuperSplat, and lcc for LCC archives.

titlestring required

Display title that will be used for the created splat.

descriptionstring required

Display description that will be used for the created splat.

softwareToolsstring[]

Optional software catalogue IDs to attribute to the created splat. Use the software catalogue endpoint to discover currently supported IDs; this field is not an OpenAPI enum because the catalogue may grow over time.

partSizeinteger required

Server-chosen target size in bytes for each uploaded part. Use this to split the file into multipart upload ranges; the final part may be smaller.

expiresAtstring date-time required

When this upload session expires.

Example response

{
  "id": "upl_0123456789abcdef01234567",
  "status": "created",
  "sourceFormat": "ply",
  "title": "garden-scan",
  "softwareTools": [
    "lcc-studio"
  ],
  "partSize": 67108864,
  "uploadedParts": [
    {
      "partNumber": 1,
      "etag": "\"abc123\"",
      "size": 67108864
    }
  ],
  "expiresAt": "2026-01-01T00:00:00.000Z"
}

Changes

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