Optimization Settings

Get a set of Optimization Settings

get

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

optimizationSettingsIdstringRequired

The ID of the Optimization Settings to get

Responses

200

Success

application/json

Responseall of

and

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/avatars/{projectId}/optimization-settings/{optimizationSettingsId} HTTP/1.1
Host: api.msquared.io
Accept: */*

{
  "id": "text",
  "name": "text",
  "preset": "low",
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  },
  "canWrite": true
}

List all Optimization Settings for a project

get

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

Query parameters

offsetinteger · int32Optional

The offset into queried items to return

limitinteger · int32 · max: 100Optional

The maximum number of items to return (maximum 100)

searchstringOptional

The search query to filter the results

Responses

200

Success

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/avatars/{projectId}/optimization-settings HTTP/1.1
Host: api.msquared.io
Accept: */*

{
  "optimizationSettings": [
    {
      "id": "text",
      "name": "text",
      "preset": "low",
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1,
  "canWrite": true
}

Create a set of Optimization Settings

post

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

Body

application/json

namestringRequired

presetstring · enumRequiredPossible values:

Responses

200

Success

application/json

default

An error occurred

application/json

post

HTTPcURLJavaScriptPython

POST /v1/avatars/{projectId}/optimization-settings HTTP/1.1
Host: api.msquared.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "preset": "low"
}

{
  "id": "text",
  "name": "text",
  "preset": "low",
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Delete a set of Optimization Settings

delete

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

optimizationSettingsIdstringRequired

The ID of the Optimization Settings to delete

Responses

204

Success

No content

default

An error occurred

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/avatars/{projectId}/optimization-settings/{optimizationSettingsId} HTTP/1.1
Host: api.msquared.io
Accept: */*

No content

Update a set of Optimization Settings

patch

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

optimizationSettingsIdstringRequired

The ID of the Optimization Settings to update

Body

application/json

namestringOptional

presetstring · enumOptionalPossible values:

Responses

200

Success

application/json

default

An error occurred

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/avatars/{projectId}/optimization-settings/{optimizationSettingsId} HTTP/1.1
Host: api.msquared.io
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "name": "text",
  "preset": "low"
}

{
  "id": "text",
  "name": "text",
  "preset": "low",
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

List usage for processing avatars for the project

get

Path parameters

projectIdstringRequired

The id of the Project

Query parameters

startTimestring · date-timeRequired

The starting ISO 8601 timestamp of the usage period

endTimestring · date-timeRequired

The ending ISO 8601 timestamp for this usage period

intervalstring · enumRequired

An ISO 8601 duration for the interval

Possible values:

optimizationSettingsIdstringOptional

The id of the Optimization Settings to filter by

Responses

200

The Optimization Settings's usage

application/json

default

An error occurred

application/json

get

HTTPcURLJavaScriptPython

GET /v1/avatars/{projectId}/optimization-settings/usage?startTime=2025-10-09T20%3A16%3A36.707Z&endTime=2025-10-09T20%3A16%3A36.707Z&interval=P1D HTTP/1.1
Host: api.msquared.io
Accept: */*

{
  "intervals": [
    {
      "startTime": "2025-10-09T20:16:36.707Z",
      "endTime": "2025-10-09T20:16:36.707Z",
      "avatarBakesCount": 1
    }
  ]
}

Initiates processing an avatar using the provided settings

put

Path parameters

projectIdstringRequired

The ID of the Project the Optimization Settings belongs to

optimizationSettingsIdstringRequired

The ID of the Optimization Settings to use for processing the avatar

Body

application/json

avatarMmlstringRequired

The MML of the avatar to process

Responses

200

Success

application/json

default

An error occurred

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/avatars/{projectId}/optimization-settings/{optimizationSettingsId}/process HTTP/1.1
Host: api.msquared.io
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "avatarMml": "text"
}

{
  "glbUrl": "text",
  "mmlUrl": "text"
}