GLB Constructor

API METHODS

HTTP type	name
PUT	/schema
PUT	/glb
POST	/assemble
POST	/token_status

/schema

Declaring a file structure for a given token.

In order to use your GLB models (e.g. clothes, hair) to create an avatar, you must declare model IDs in the models config.

Model config example: There are 2 types of models declared here: a hair model and a body model. "hair_male", "hair_female", "body_01" are IDs for each GLB model you upload.

models_config.json

{
	"hair" : [
		"hair_male", "hair_female"
	],
	"body": [
		"body_01"
	]
}

Method for loading the schema

PUT https://api.metahumansdk.io/glb_const/schema

Declaring a file structure for a given token.

Request Body

Name	Type	Description
token*	string	Registered token.
schema*	binary	JSON file with description of the structure of your models.

200: OK The request is successful

{
  "result": {
    "status": "schema loaded successfully"
  }
}

422: Unprocessable Entity Error while processing

{
    "error": {
            "code": int
            "message": str
    }
}

Check in ERRORS section for possible error response examples.

/glb

Uploading the GLB model declared in your schema.

A token is used for authorization.

Note: the GLB models you upload must fit our embbeded head size and position.

Method for loading GLB models

PUT https://api.metahumansdk.io/glb_const/glb

Upload your GLB model declared in your schema.

Request Body

Name	Type	Description
token*	string	Registered token.
data*	binary	GLB model loaded as a binary stream using an in-memory bytes buffer.
sha256*	string	Check sum sha256 of GLB file.
data_type*	string	Loaded model type in schema.
data_id*	string	Loaded model ID in schema.

200: OK The request is successful

{
  "result": {
    "status": "model loaded successfully"
  }
}

422: Unprocessable Entity Error while processing

{
    "error": {
            "code": int
            "message": str
    }
}

Check in ERRORS section for possible error response examples.

/assemble

Assembling the GLB model of a 3D avatar.

Embbeded head model description:

• number of vertices: 5255

• UV texture: created using 3D Face Reconstruction Service from photo

• blendshapes: ARKit standard

Method for constructing result GLB

POST https://api.metahumansdk.io/glb_const/assemble

Assembling a GLB model of an 3D avatar.

Request Body

Name	Type	Description
token*	string	Registered token.
head_uv*	binary	Image texture from 3D Face Reconstruction Service.
head_config*	binary	JSON file with model parameters from 3D Face Reconstruction Service.
models_congig*	binary	JSON file with model ID for model types from the schema.
custom_models	array	List of custom (not preloaded) GLB model loaded as a binary stream using an in-memory bytes buffer.
add_facs	boolean	Adding FACS blendshapes in GLB model.

200: OK the request is successful, a file with GLB model will be returned

string($binary)

422: Unprocessable Entity the input could not be interpreted correctly

{
    "error": {
            "code": int
            "message": str
    }
}

Check in ERRORS section for possible error response examples.

/status

Server and token health check.

Method for checking status

POST https://api.metahumansdk.io/glb_const/status

Server and token health check.

Request Body

Name	Type	Description
token	string	Registered token.

200: OK the request is successful

{
    "result": {
        "status": "ok"
    }
}

422: Unprocessable Entity Error while processing

{
    "error": {
            "code": int
            "message": str
    }
}

Check in ERRORS section for possible error response examples.