avaturn

Manages creation and edition of avaturn avatars

Creates a new avaturn session

POSThttp://admin.m2worlds.io/api/avaturn/create/

Authorization

BearerAuth

Header parameters

Response

200

Parameters of the new Avaturn session

Body

application/json

uploadUrl*string (uri)

sdkSessionUrl*string (uri)

sessionId*string

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/create/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "uploadUrl": "https://example.com",
  "sdkSessionUrl": "https://example.com",
  "sessionId": "text"
}

Edits an existing avaturn model

POSThttp://admin.m2worlds.io/api/avaturn/edit/

Authorization

BearerAuth

Header parameters

Body

application/json

datasourceId*string

The ID of a datasource

objectDefinitionId*string

The ID of an object definition

Response

200

Parameters of the edit Avaturn session

Body

application/json

editorUrl*string (uri)

sessionId*string

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/edit/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "datasourceId": "text",
      "objectDefinitionId": "text"
    }),
});
const data = await response.json();

Response

{
  "editorUrl": "https://example.com",
  "sessionId": "text"
}

Saves an Avaturn session avatar to the user's profile

POSThttp://admin.m2worlds.io/api/avaturn/edit/{sessionId}/complete

Path parameters

sessionId*string

Header parameters

Response

200

Default Response

Body

application/json

needToExport*boolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/edit/{sessionId}/complete', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "needToExport": false
}

Webhook from Avaturn when an avatar has been exported

POSThttp://admin.m2worlds.io/api/avaturn/exported/

Header parameters

Body

application/json

avatar_id*string

user_id*string

export_url*string

status*any of

enumenum

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/exported/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "avatar_id": "text",
      "user_id": "text",
      "export_url": "text",
      "status": "ready"
    }),
});
const data = await response.json();

Service health check

GEThttp://admin.m2worlds.io/api/avaturn/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Webhook from Avaturn when an avatar is ready to be dressed

POSThttp://admin.m2worlds.io/api/avaturn/ready/

Header parameters

Body

application/json

avatar_id*string

session_id*string

user_id*string

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/ready/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "avatar_id": "text",
      "session_id": "text",
      "user_id": "text"
    }),
});
const data = await response.json();

Check avaturn session status, if the session is complete or errored then will delete after this call

PUThttp://admin.m2worlds.io/api/avaturn/status/{sessionId}

Authorization

BearerAuth

Path parameters

sessionId*string

Header parameters

Response

200

Default Response

Body

application/json

state*string

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/avaturn/status/{sessionId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "state": "text"
}