Contents
This page contains a step-by-step tutorial on how to create a MetaPerson 2.0 avatar from a photo and download the avatar's mesh, haircut, and outfit in glb format using the curl command-line utility.
To obtain the curl utility for Windows, please visit the following page: https://curl.haxx.se/windows/. Please consult the help of your Linux/macOS distributive packaging system to install the curl utility.
Please note that code sample syntax is different for Windows and Linux/macOS platforms, thus see the corresponding sample section for your platform by clicking on the platform title.
During the steps below we will show how to create a female avatar. The process will be almost the same for male avatars excepting the subtype and available resources.
First of all, you will need to obtain an authorization token to run any request to the Avatar SDK WEB API. To do this you will need the App Client ID and App Client Secret from the Client Access application (please find the difference between client and developer access applications here: Developer/Client access). Visit the HTTP API section of your developer page here: accounts.avatarsdk.com/developer (create a new application if you have none yet). Please make sure you have set Authorization Grant to the Client credentials.
Set the CLIENT_ID and CLIENT_SECRET to the corresponding values, run the authorization request, and set the TOKEN variable to the access_token value after successful authorization:
SET "CLIENT_ID=xFXeBr4shmgHUiymYwW7sDOO9BbwtL3eJkCE3OKu" SET "CLIENT_SECRET=hpAYUxCLfKHEkIvRgXTZzGyMvgDj7Tdg4gBhu5nmXjtW0ODMj0HUCt3tmKMBtm94qzcNsVhK6xXj2PKEop7BxBi1W9XMvyx3p9tJVP6mGY19THuS6mNSnJiQI1vQ0QE6" curl -X POST --user "%CLIENT_ID%:%CLIENT_SECRET%" ^ "https://api.avatarsdk.com/o/token/" ^ -F "grant_type=client_credentials" { "access_token": "PAvD64lbikgVA0GzxgKV2ZhLnPbZ8P", "token_type": "Bearer", "expires_in": 36000, "scope": "read write" } SET "TOKEN=PAvD64lbikgVA0GzxgKV2ZhLnPbZ8P"
CLIENT_ID="xFXeBr4shmgHUiymYwW7sDOO9BbwtL3eJkCE3OKu" CLIENT_SECRET="hpAYUxCLfKHEkIvRgXTZzGyMvgDj7Tdg4gBhu5nmXjtW0ODMj0HUCt3tmKMBtm94qzcNsVhK6xXj2PKEop7BxBi1W9XMvyx3p9tJVP6mGY19THuS6mNSnJiQI1vQ0QE6" curl -X POST --user "$CLIENT_ID:$CLIENT_SECRET" \ "https://api.avatarsdk.com/o/token/" \ -F "grant_type=client_credentials" { "access_token": "PAvD64lbikgVA0GzxgKV2ZhLnPbZ8P", "token_type": "Bearer", "expires_in": 36000, "scope": "read write" } TOKEN="PAvD64lbikgVA0GzxgKV2ZhLnPbZ8P"
Please note, that token will expire in 36000 seconds and you will need to run the authorization procedure again.
Although this step is completely optional, it is a good idea to create a Player ID and use it for any further avatar-related requests: this way you will be able to list all your previously created avatars as well as edit their description and protect them from deletion by others in a multi-player experience. There are also higher request throttling limits set per Player ID rather than the whole developer account. Please find more information on request rate throttling here: Throttling.
Using the TOKEN obtained in the previous step, run the Player ID creation request and set the PLAYER variable to the obtained code value:
curl -H "Authorization: Bearer %TOKEN%" ^ -X POST ^ "https://api.avatarsdk.com/players/" ^ -F "comment=curl sample" { "url": "https://api.avatarsdk.com/players/16322807-89e3-4223-a83c-1d6afa8abd11/", "code": "16322807-89e3-4223-a83c-1d6afa8abd11", "created_on": "2020-04-14T07:09:55.976235Z", "comment": "curl sample" } SET "PLAYER=16322807-89e3-4223-a83c-1d6afa8abd11"
curl -H "Authorization: Bearer $TOKEN" \ -X POST \ "https://api.avatarsdk.com/players/" \ -F "comment=curl sample" { "url": "https://api.avatarsdk.com/players/16322807-89e3-4223-a83c-1d6afa8abd11/", "code": "16322807-89e3-4223-a83c-1d6afa8abd11", "created_on": "2020-04-14T07:09:55.976235Z", "comment": "curl sample" } PLAYER="16322807-89e3-4223-a83c-1d6afa8abd11"
Please note, that the Player ID does not expire so you do not need to create a new Player ID every time on the same device - you could use a previously created one.
There are several avatar computation time parameters, which may improve the resulting avatar quality, and customize it as well as purely informational ones. Please find more information on the computational parameters here: Computation parameters.
To retrieve a list of available parameters for the female subtype of metaperson_2.0 pipeline, run the parameters retrieval request with the the TOKEN obtained on the authorization step:
curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ "https://api.avatarsdk.com/parameters/available/metaperson_2.0/?pipeline_subtype=female" { "female": { "avatar_modifications": [ "remove_smile", "remove_glasses", "remove_stubble" ], "model_info": [ "gender", "race", "age", "hair_color", "skin_color", "eye_sclera_color", "eye_iris_color" ] } }
curl -H "Authorization: Bearer $TOKEN" \ -X GET \ "https://api.avatarsdk.com/parameters/available/metaperson_2.0/?pipeline_subtype=female" { "female": { "avatar_modifications": [ "remove_smile", "remove_glasses", "remove_stubble" ], "model_info": [ "gender", "race", "age", "hair_color", "skin_color", "eye_sclera_color", "eye_iris_color" ] } }
Please note, that this request is useful only during parameter discovery and should be omitted during normal application workflow once you figure out which parameters fit you best.
To obtain a computed avatar in one of the common 3D mesh file formats as well as customize avatar parts and assets you will need to specify export parameters. Export parameters for a particular pipeline type consist of various flags (like mesh file format, level of mesh details, etc.) and enumerable parameters that vary depending on the pipeline subtype (like avatar body parts, textures, outfits, etc.) Please find more information on export parameters here: Export parameters. Please also find frequently asked questions on export parameters usage here:FAQ.
To retrieve a list of available enumerable export parameters for the female subtype of metaperson_2.0 pipeline, run enumerable export parameters retrieval request with the TOKEN obtained on the authorization step:
curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ "https://api.avatarsdk.com/export_parameters/available/metaperson_2.0/?pipeline_subtype=female" { "blendshapes": { "list": [ "body_shape", "face_modifications", "mobile_51", "visemes_14", "visemes_15" ] }, "outfits_shoes": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "sneakers_ARPI", "sneakers_AZAT" ] }, "outfits": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "HeadVisibilityMask", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "ARPI", "CHATIN", "LORI", "dress_Shaki" ] }, "outfits_bottom": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "Metallic", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "jeans_AYGER", "jeans_SWAN", "jeans_VEDI", "shorts_Vedi" ] }, "haircuts": { "textures": [ "AO", "Alpha", "Color", "Depth", "GltfMetallicRoughness", "Normal", "Root", "Roughness", "Scalp", "Shade", "UniqueID", "UnityMetallicSmoothness" ], "list": [ "Haircut0", "Haircut1", "Haircut10", "Haircut11", "Haircut12", "Haircut13", "Haircut2", "Haircut3", "Haircut4", "Haircut5", "Haircut6", "Haircut7", "Haircut8", "Haircut9", "HaircutGenerated" ] }, "avatar": { "textures": [ "Color", "GltfMetallicRoughness", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "AvatarBody", "AvatarEyelashes", "AvatarHead", "AvatarLeftCornea", "AvatarLeftEyeball", "AvatarRightCornea", "AvatarRightEyeball", "AvatarTeethLower", "AvatarTeethUpper" ] }, "glasses": { "textures": [ "Color", "GltfMetallicRoughness", "Metallic", "Roughness", "UnityMetallicSmoothness" ], "list": [ "glasses_00", "glasses_01", "glasses_02", "glasses_03", "glasses_04", "glasses_05", "glasses_06", "glasses_07", "glasses_08", "glasses_09", "glasses_10", "glasses_11", "glasses_12", "glasses_13", "glasses_14", "glasses_15" ] }, "outfits_top": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "HeadVisibilityMask", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "hoodie_ARAS", "polo_Jil", "t-shirt_ARPI" ] } }
curl -H "Authorization: Bearer $TOKEN" \ -X GET \ "https://api.avatarsdk.com/export_parameters/available/metaperson_2.0/?pipeline_subtype=female" { "blendshapes": { "list": [ "body_shape", "face_modifications", "mobile_51", "visemes_14", "visemes_15" ] }, "outfits_shoes": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "sneakers_ARPI", "sneakers_AZAT" ] }, "outfits": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "HeadVisibilityMask", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "ARPI", "CHATIN", "LORI", "dress_Shaki" ] }, "outfits_bottom": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "Metallic", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "jeans_AYGER", "jeans_SWAN", "jeans_VEDI", "shorts_Vedi" ] }, "haircuts": { "textures": [ "AO", "Alpha", "Color", "Depth", "GltfMetallicRoughness", "Normal", "Root", "Roughness", "Scalp", "Shade", "UniqueID", "UnityMetallicSmoothness" ], "list": [ "Haircut0", "Haircut1", "Haircut10", "Haircut11", "Haircut12", "Haircut13", "Haircut2", "Haircut3", "Haircut4", "Haircut5", "Haircut6", "Haircut7", "Haircut8", "Haircut9", "HaircutGenerated" ] }, "avatar": { "textures": [ "Color", "GltfMetallicRoughness", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "AvatarBody", "AvatarEyelashes", "AvatarHead", "AvatarLeftCornea", "AvatarLeftEyeball", "AvatarRightCornea", "AvatarRightEyeball", "AvatarTeethLower", "AvatarTeethUpper" ] }, "glasses": { "textures": [ "Color", "GltfMetallicRoughness", "Metallic", "Roughness", "UnityMetallicSmoothness" ], "list": [ "glasses_00", "glasses_01", "glasses_02", "glasses_03", "glasses_04", "glasses_05", "glasses_06", "glasses_07", "glasses_08", "glasses_09", "glasses_10", "glasses_11", "glasses_12", "glasses_13", "glasses_14", "glasses_15" ] }, "outfits_top": { "textures": [ "BodyVisibilityMask", "Color", "GltfMetallicRoughness", "HeadVisibilityMask", "Normal", "Roughness", "UnityMetallicSmoothness" ], "list": [ "hoodie_ARAS", "polo_Jil", "t-shirt_ARPI" ] } }
Please note, that this request is useful only during parameter discovery and should be omitted during regular application workflow once you figure out which parameters fit you best.
It is really important to choose the required export parameters for your avatar. Please pay attention to the format, lod, and profile fields. Also please check the documentation for the finalize flag and FAQ, it can be useful in some use cases.
We will use the following computation parameters for our avatar:
{ "avatar_modifications": { "remove_smile": true, "remove_glasses": true } }
And the following export parameters:
{ "format": "glb", "lod": "LOD1", "embed": true, "textures": { "list": [ "Color", "Normal", "GltfMetallicRoughness", "BodyVisibilityMask", "HeadVisibilityMask" ], "embed": true, "profile": "1K.png" }, "avatar": { "list": [ "AvatarBody", "AvatarEyelashes", "AvatarHead", "AvatarLeftCornea", "AvatarLeftEyeball", "AvatarRightCornea", "AvatarRightEyeball", "AvatarTeethLower", "AvatarTeethUpper" ] }, "blendshapes": { "list": ["face_modifications", "body_shape", "mobile_51"] }, "haircuts": { "list": ["HaircutGenerated"] }, "outfits": { "list": ["LORI"] } }
Save avatar parameters and export parameters into the files parameters.json and export_parameters.json correspondingly. Run the avatar computation request with the parameters files above, the photo.jpg image from the current directory (adjust path if necessary), TOKEN and PLAYER values obtained earlier and save the avatar code for further use:
curl -H "Authorization: Bearer %TOKEN%" ^ -H "X-PlayerUID: %PLAYER%" ^ -X POST "https://api.avatarsdk.com/avatars/" ^ -F "name=test from curl sample" ^ -F "pipeline=metaperson_2.0" ^ -F "pipeline_subtype=female" ^ -F "parameters=<parameters.json" ^ -F "export_parameters=<export_parameters.json" ^ -F "photo=@photo.jpg" { "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "description": "test from curl sample", "progress": 0, "status": "Uploading", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" } SET "AVATAR=096281e9-fc9e-4b5b-bf3d-9ac68b5ca637"
curl -H "Authorization: Bearer $TOKEN" \ -H "X-PlayerUID: $PLAYER" \ -X POST "https://api.avatarsdk.com/avatars/" \ -F "name=test from curl sample" \ -F "pipeline=metaperson_2.0" \ -F "pipeline_subtype=female" \ -F "parameters=<parameters.json" \ -F "export_parameters=<export_parameters.json" \ -F "photo=@photo.jpg" { "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "description": "test from curl sample", "progress": 0, "status": "Uploading", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" } AVATAR="096281e9-fc9e-4b5b-bf3d-9ac68b5ca637"
Avatar computation starts after uploading the photo. Request the avatar status periodically (once per 5 seconds should be enough) to check avatar computation status and progress by running avatar retrieval request:
curl -H "Authorization: Bearer %TOKEN%" ^ -H "X-PlayerUID: %PLAYER%" ^ -X GET ^ "https://api.avatarsdk.com/avatars/%AVATAR%/" { "blendshapes": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/blendshapes/", "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "ctime": null, "description": "", "exports": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/", "haircuts": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/haircuts/", "mesh": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/mesh/", "model_info": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/model_info/", "name": "test from curl sample", "pipeline": null, "pipeline_subtype": null, "preview": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/preview/", "progress": 0, "status": "Computing", "texture": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/texture/", "thumbnail": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/thumbnail/", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" }
curl -H "Authorization: Bearer $TOKEN" \ -H "X-PlayerUID: $PLAYER" \ -X GET \ "https://api.avatarsdk.com/avatars/$AVATAR/" { "blendshapes": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/blendshapes/", "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "ctime": null, "description": "", "exports": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/", "haircuts": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/haircuts/", "mesh": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/mesh/", "model_info": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/model_info/", "name": "test from curl sample", "pipeline": null, "pipeline_subtype": null, "preview": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/preview/", "progress": 0, "status": "Computing", "texture": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/texture/", "thumbnail": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/thumbnail/", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" }
Once the avatar is ready, its status is set to Completed and progress is 100:
curl -H "Authorization: Bearer %TOKEN%" ^ -H "X-PlayerUID: %PLAYER%" ^ -X GET ^ "https://api.avatarsdk.com/avatars/%AVATAR%/" { "blendshapes": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/blendshapes/", "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "ctime": null, "description": "", "exports": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/", "haircuts": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/haircuts/", "mesh": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/mesh/", "model_info": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/model_info/", "name": "test from curl sample", "pipeline": "metaperson_2.0", "pipeline_subtype": "female", "preview": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/preview/", "progress": 100, "status": "Completed", "texture": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/texture/", "thumbnail": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/thumbnail/", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" }
curl -H "Authorization: Bearer $TOKEN" \ -H "X-PlayerUID: $PLAYER" \ -X GET \ "https://api.avatarsdk.com/avatars/$AVATAR/" { "blendshapes": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/blendshapes/", "code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "created_on": "2020-11-24T13:39:53.490812Z", "ctime": null, "description": "", "exports": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/", "haircuts": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/haircuts/", "mesh": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/mesh/", "model_info": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/model_info/", "name": "test from curl sample", "pipeline": "metaperson_2.0", "pipeline_subtype": "female", "preview": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/preview/", "progress": 100, "status": "Completed", "texture": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/texture/", "thumbnail": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/thumbnail/", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/" }
Once the avatar is ready, check the avatar exports status by running the avatar exports list request and save the avatar export code for further use:
curl -H "Authorization: Bearer %TOKEN%" ^ -H "X-PlayerUID: %PLAYER%" ^ -X GET ^ "https://api.avatarsdk.com/avatars/%AVATAR%/exports/" [ { "avatar_code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "code": "a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2", "created_on": "2020-11-24T13:39:53.490812Z", "files": [ { "category": null, "file": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2/files/avatar/file/", "identity": "avatar", "static_files": [ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_GltfMetallicRoughness_512.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_Normal_512.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Color_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_Normal_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_BodyVisibilityMask_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Color_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_HeadVisibilityMask_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Normal_1K.png" ] } ], "status": "Completed", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2/" } ] SET "EXPORT=a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2"
curl -H "Authorization: Bearer $TOKEN" \ -H "X-PlayerUID: $PLAYER" \ -X GET \ "https://api.avatarsdk.com/avatars/$AVATAR/exports/" [ { "avatar_code": "096281e9-fc9e-4b5b-bf3d-9ac68b5ca637", "code": "a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2", "created_on": "2020-11-24T13:39:53.490812Z", "files": [ { "category": null, "file": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2/files/avatar/file/", "identity": "avatar", "static_files": [ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_GltfMetallicRoughness_512.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_Normal_512.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Color_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Normal1_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_Normal_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_BodyVisibilityMask_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Color_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_GltfMetallicRoughness_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_HeadVisibilityMask_1K.png", "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Normal_1K.png" ] } ], "status": "Completed", "url": "https://api.avatarsdk.com/avatars/096281e9-fc9e-4b5b-bf3d-9ac68b5ca637/exports/a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2/" } ] EXPORT="a1c2f9c9-e540-4484-9c3b-1e901b8a8fa2"
Once the avatar export is ready its status is set to Completed, and you can download all its files: avatar mesh with blendshapes, haircuts, and outfits in one unified glb (as requested per export parameters) by running the avatar export file retrieval request:
curl -H "Authorization: Bearer %TOKEN%" ^ -H "X-PlayerUID: %PLAYER%" ^ -X GET ^ "https://api.avatarsdk.com/avatars/%AVATAR%/exports/%EXPORT%/files/avatar/file/" ^ -o "model.zip"
curl -H "Authorization: Bearer $TOKEN" \ -H "X-PlayerUID: $PLAYER" \ -X GET \ "https://api.avatarsdk.com/avatars/$AVATAR/exports/$EXPORT/files/avatar/file/" \ -o "model.zip"
Please note, that avatar export contains links to the static resources - the files that do not change from avatar to avatar and could be downloaded only once and used for all further avatars. Please find more information about static resources here: Static resources.
To download static resources files just follow the links in the static_files section of the avatar export:
curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_Normal1_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_GltfMetallicRoughness_512.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_Normal_512.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_Normal1_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Color_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Normal1_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_Normal_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_BodyVisibilityMask_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Color_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_HeadVisibilityMask_1K.png" curl -H "Authorization: Bearer %TOKEN%" ^ -X GET ^ -JLO ^ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Normal_1K.png"
curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarBodyFemale/AvatarBodyFemale_Normal1_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_GltfMetallicRoughness_512.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarEyes/AvatarEyes_Normal_512.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarHeadFemale/AvatarHeadFemale_Normal1_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Color_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/avatar/AvatarTeeth/AvatarTeeth_Normal1_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/haircuts/HaircutGenerated/HaircutGenerated_Normal_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_BodyVisibilityMask_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Color_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_GltfMetallicRoughness_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_HeadVisibilityMask_1K.png" curl -H "Authorization: Bearer $TOKEN" \ -X GET \ -JLO \ "https://api.avatarsdk.com/static_resources/metaperson_2.0/textures/outfits/LORI/LORI_Normal_1K.png"