Avatar Creators

List all creator configs for a project

get

Path parameters

projectIdstringRequired

The ID of the Project the Creator Config 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

totalResultsintegerRequired

The total number of results, before applying the limit and offset

offsetintegerRequired

The offset into queried items to return

limitintegerRequired

The maximum number of items to return

canWritebooleanRequired

Whether the user has write permissions

default

An error occurred

application/json

get

/v1/avatars/{projectId}/creator-configs

HTTPcURLJavaScriptPython

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

{
  "creatorConfigs": [
    {
      "id": "text",
      "name": "text",
      "catalog": {
        "mode": "text"
      },
      "allowedHost": null,
      "createdAt": "text",
      "createdBy": {
        "userId": "text",
        "type": "user"
      }
    }
  ],
  "totalResults": 1,
  "offset": 1,
  "limit": 1,
  "canWrite": true
}

Get a creator config

get

Path parameters

projectIdstringRequired

The ID of the Project the Creator Config belongs to

creatorConfigIdstringRequired

The ID of the Creator Config to get

Responses

200

Success

application/json

and

default

An error occurred

application/json

get

/v1/avatars/{projectId}/creator-configs/{creatorConfigId}

HTTPcURLJavaScriptPython

GET /v1/avatars/{projectId}/creator-configs/{creatorConfigId} HTTP/1.1
Host: api.msquared.io
Accept: */*

{
  "id": "text",
  "name": "text",
  "catalog": {
    "mode": "text"
  },
  "allowedHost": null,
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  },
  "embeddableUrl": "text",
  "canWrite": true
}

Delete a creator config

delete

Path parameters

projectIdstringRequired

The ID of the Project the Creator Config belongs to

creatorConfigIdstringRequired

The ID of the Creator Config to delete

Responses

204

Success

default

An error occurred

application/json

delete

/v1/avatars/{projectId}/creator-configs/{creatorConfigId}

HTTPcURLJavaScriptPython

DELETE /v1/avatars/{projectId}/creator-configs/{creatorConfigId} HTTP/1.1
Host: api.msquared.io
Accept: */*

No content

Update a creator config

patch

Path parameters

projectIdstringRequired

The ID of the Project the Creator Config belongs to

creatorConfigIdstringRequired

The ID of the Creator Config to update

Body

application/json

namestringOptional

catalogone ofOptional

or

allowedHoststring · nullableOptional

Responses

200

Success

application/json

idstringRequired

namestringRequired

catalogone ofRequired

or

allowedHoststring · nullableOptional

createdAtstringOptional

createdByone ofOptional

or

default

An error occurred

application/json

patch

/v1/avatars/{projectId}/creator-configs/{creatorConfigId}

HTTPcURLJavaScriptPython

PATCH /v1/avatars/{projectId}/creator-configs/{creatorConfigId} HTTP/1.1
Host: api.msquared.io
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "catalog": {
    "mode": "text"
  },
  "allowedHost": null
}

{
  "id": "text",
  "name": "text",
  "catalog": {
    "mode": "text"
  },
  "allowedHost": null,
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}

Create a new creator config

post

Path parameters

projectIdstringRequired

The ID of the Project the Creator Config belongs to

Body

application/json

namestringRequired

catalogone ofRequired

or

allowedHoststring · nullableRequired

Responses

200

Success

application/json

idstringRequired

namestringRequired

catalogone ofRequired

or

allowedHoststring · nullableOptional

createdAtstringOptional

createdByone ofOptional

or

default

An error occurred

application/json

post

/v1/avatars/{projectId}/creator-configs

HTTPcURLJavaScriptPython

POST /v1/avatars/{projectId}/creator-configs HTTP/1.1
Host: api.msquared.io
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "catalog": {
    "mode": "text"
  },
  "allowedHost": null
}

{
  "id": "text",
  "name": "text",
  "catalog": {
    "mode": "text"
  },
  "allowedHost": null,
  "createdAt": "text",
  "createdBy": {
    "userId": "text",
    "type": "user"
  }
}