> For the complete documentation index, see [llms.txt](https://docs.gmetri.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gmetri.com/metaverse/sdk/gmetri-sdk-apis.md).

# 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](https://drive.google.com/file/d/1f2eZQ3uCiKk_EBnxughXoRMr9TtSGCS2/view). It's definitions and factory functions are [open source](https://github.com/gmetrixr/rjson) and [published here](https://www.npmjs.com/package/@gmetrixr/rjson). Most objects in GMetri are of the type `RecordNode<RT.`*`subtype`*`>`.

### Reponses and Error Handling

All responses are of the following type:

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

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

### APIs

{% content-ref url="/pages/hozkgJKTd9gypLDGjCU5" %}
[Project](/metaverse/sdk/gmetri-sdk-apis/project.md)
{% endcontent-ref %}

{% content-ref url="/pages/AAol9g5hx5Sq4m7X9VWE" %}
[Deployment](/metaverse/sdk/gmetri-sdk-apis/deployment.md)
{% endcontent-ref %}

{% content-ref url="/pages/DYM2IYzjg7Qvb1ktdqHI" %}
[File](/metaverse/sdk/gmetri-sdk-apis/file.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.gmetri.com/metaverse/sdk/gmetri-sdk-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.