GMetri SDK APIs

Nomenclature

There are certain nomenclature differences between the GMetri Portal and the GMetri SDK. In the SDK, a workspace is referred to as "organization" and an experience is called "project".

RecordNode type

Most objects in GMetri (Project, Scene, Elements, Rule etc.) are of this type.

RecordNode is a recursive type described here. It's definitions and factory functions are open source and published here. Most objects in GMetri are of the type RecordNode<RT.subtype>.

Reponses and Error Handling

All responses are of the following type:

//Response Shape
type { 
  status: OperationStatus, //Defined below
  data?: DataFromTheApi //Popuplated only if success === true
}

interface OperationStatus {
  success: boolean
  errorCode?: number
  errorMessage?: string
}

APIs

Project

Deployment

File