API Reference

Overview

🤖 A stunningly realistic features and lifelike movements.

The Avatars endpoint is an API endpoint within the Yepic API Platform that provides users access to a collection of pre-designed or customizable avatar images.

☎️ API Calls - Examples

📘

Info

Please refer to this page for list of stock avatars.

1. GET - Retrieve an avatar

Use this endpoint to get a specific avatar by using its ID. 

curl --request GET \
     --url https://api.yepic.ai/v1/avatars/31811055-83c9-47ef-a762-b75d5882665c \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'

{
  "id": "31811055-83c9-47ef-a762-b75d5882665c",
  "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/31811055-83c9-47ef-a762-b75d5882665c.png",
  "name": "Simon",
  "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/31811055-83c9-47ef-a762-b75d5882665c.png",
  "gender": "Male",
  "fullTrial": false,
  "talkingPhoto": true
}

2. GET - Retrieve a list of avatars

Use this endpoint to obtain a list of our avatars.

curl --request GET \
     --url https://api.yepic.ai/v1/avatars \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'

{
  "avatars": [
    {
      "id": "01b663b8-139d-4146-9530-70e921f9e5d0",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/01b663b8-139d-4146-9530-70e921f9e5d0.png",
      "name": "Santa",
      "menuCircleImageUrl": "",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "0993a69a-153b-4c50-a60c-4d60ebe938e6",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/0993a69a-153b-4c50-a60c-4d60ebe938e6.png",
      "name": "Michael",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/0993a69a-153b-4c50-a60c-4d60ebe938e6.png",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "71e917af-dc2e-424d-a7c7-b35635d30a3d",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/71e917af-dc2e-424d-a7c7-b35635d30a3d.png",
      "name": "Mike",
      "menuCircleImageUrl": "",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "c7ba1ea8-1047-463c-b498-1d0197a0e01e",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/c7ba1ea8-1047-463c-b498-1d0197a0e01e.png",
      "name": "Brendon",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/c7ba1ea8-1047-463c-b498-1d0197a0e01e.png",
      "gender": "Male",
      "fullTrial": true,
      "talkingPhoto": true
    },
    {
      "id": "e02bd65e-abe6-4da3-922f-4d4e1813c411",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/e02bd65e-abe6-4da3-922f-4d4e1813c411.png",
      "name": "Matthias",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/e02bd65e-abe6-4da3-922f-4d4e1813c411.png",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "e2aec37d-da42-46e1-8408-bdeb5384c97f",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/e2aec37d-da42-46e1-8408-bdeb5384c97f.png",
      "name": "Ryan",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/e2aec37d-da42-46e1-8408-bdeb5384c97f.png",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "ea03926b-a6fb-4bce-88d4-8c6bd35aaf05",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/ea03926b-a6fb-4bce-88d4-8c6bd35aaf05.png",
      "name": "Alexander",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/ea03926b-a6fb-4bce-88d4-8c6bd35aaf05.png",
      "gender": "Male",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "335d6224-8c39-48eb-a2b0-38a3b88015c1",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/335d6224-8c39-48eb-a2b0-38a3b88015c1.png",
      "name": "Yunqi",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "36b744fa-2b14-4348-8b6c-7151bc7e8be6",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/36b744fa-2b14-4348-8b6c-7151bc7e8be6.png",
      "name": "Anya",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "36ddf318-b8bb-44b5-837f-89478caec740",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/36ddf318-b8bb-44b5-837f-89478caec740.png",
      "name": "Ana",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "3891a2d6-9447-443a-9fe5-ab42679adead",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/3891a2d6-9447-443a-9fe5-ab42679adead.png",
      "name": "Anya",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/3891a2d6-9447-443a-9fe5-ab42679adead.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "3bfc9743-a530-44d7-9980-6af1993e81b2",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/3bfc9743-a530-44d7-9980-6af1993e81b2.png",
      "name": "Lyanna",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/3bfc9743-a530-44d7-9980-6af1993e81b2.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "a9055ce4-f63e-40dc-8e3a-beb8500be30c",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/a9055ce4-f63e-40dc-8e3a-beb8500be30c.png",
      "name": "Lena",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/a9055ce4-f63e-40dc-8e3a-beb8500be30c.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "af54be63-a939-456b-8487-6f5e25fa28ce",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/af54be63-a939-456b-8487-6f5e25fa28ce.png",
      "name": "Elsa",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/af54be63-a939-456b-8487-6f5e25fa28ce.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "b975ea8e-0605-46f6-972c-e74a303e9f11",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/b975ea8e-0605-46f6-972c-e74a303e9f11.png",
      "name": "Ella",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/b975ea8e-0605-46f6-972c-e74a303e9f11.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "ccc6aaa4-07f7-4b5d-a44f-b728dd7323a7",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/ccc6aaa4-07f7-4b5d-a44f-b728dd7323a7.png",
      "name": "Yunqi",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/ccc6aaa4-07f7-4b5d-a44f-b728dd7323a7.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "cf0307db-e577-422a-91ff-b7215c13fa28",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/cf0307db-e577-422a-91ff-b7215c13fa28.png",
      "name": "Carter",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "d18e1216-7102-4b3b-b725-56a59649cad3",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/d18e1216-7102-4b3b-b725-56a59649cad3.png",
      "name": "Dylan",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "d2338c99-895a-47c7-bbe2-e189f828e37f",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/d2338c99-895a-47c7-bbe2-e189f828e37f.png",
      "name": "Meghan",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/d2338c99-895a-47c7-bbe2-e189f828e37f.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "dc6e28eb-96cd-4ac5-b5df-78199788a2c3",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/dc6e28eb-96cd-4ac5-b5df-78199788a2c3.png",
      "name": "Chevin",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/dc6e28eb-96cd-4ac5-b5df-78199788a2c3.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "dcef7529-c6ce-42e8-9c15-3956499da0da",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/dcef7529-c6ce-42e8-9c15-3956499da0da.png",
      "name": "Ana",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "f09e2457-c5b9-4972-94f2-b042fde41700",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/f09e2457-c5b9-4972-94f2-b042fde41700.png",
      "name": "Adriana",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "f1365f5c-945f-4091-990c-c731ba5ac0f2",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/f1365f5c-945f-4091-990c-c731ba5ac0f2.png",
      "name": "Adriana",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/f1365f5c-945f-4091-990c-c731ba5ac0f2.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    },
    {
      "id": "fad8c893-58ed-4855-b099-336580ec910f",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/fad8c893-58ed-4855-b099-336580ec910f.png",
      "name": "Ana",
      "menuCircleImageUrl": "",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": false
    },
    {
      "id": "fdb3ddcb-b071-43d3-a45a-a6be712b1b5b",
      "menuImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website/fdb3ddcb-b071-43d3-a45a-a6be712b1b5b.png",
      "name": "Jordyn",
      "menuCircleImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/website_circle/fdb3ddcb-b071-43d3-a45a-a6be712b1b5b.png",
      "gender": "Female",
      "fullTrial": false,
      "talkingPhoto": true
    }
  ]
}

3. POST - Create an avatar

Use this endpoint to Create new Avatar.

curl --request POST \
     --url https://api.yepic.ai/v1/avatars \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "Yvonne",
  "gender": "Female",
  "age": 41,
  "inputImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
  "ziggeoConsentId": null
}
'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "createDate": null,
  "userId": null,
  "organizationId": null,
  "memberstackId": null,
  "name": "Yvonne",
  "age": 41,
  "gender": "Female",
  "fullTrial": null,
  "avatarStatus": null,
  "inputImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
  "rawImageUrl": null,
  "menuImageUrl": null,
  "menuCircleImageUrl": null,
  "talkingPhoto": null,
  "talkingPhotoUpperBody": null,
  "publicAvatar": null,
  "customAvatar": null,
  "ziggeoConsentId": null
}

4. PATCH - Update an Avatar

Use this endpoint to get a specific avatar by using its ID.

curl --request PATCH \
     --url https://api.yepic.ai/v1/avatars/id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "name": "Yvonne",
  "age": 41,
  "gender": "Female",
  "ziggeoConsentId": null
}
'

{
  "id": "00000000-0000-0000-0000-000000000000",
  "createDate": null,
  "userId": null,
  "organizationId": null,
  "memberstackId": null,
  "name": "Yvonne",
  "age": 41,
  "gender": "Female",
  "fullTrial": null,
  "avatarStatus": null,
  "inputImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
  "rawImageUrl": null,
  "menuImageUrl": null,
  "menuCircleImageUrl": null,
  "talkingPhoto": null,
  "talkingPhotoUpperBody": null,
  "publicAvatar": null,
  "customAvatar": null,
  "ziggeoConsentId": null
}

5. DELETE - Delete an Avatar

Use this endpoint to get a specific avatar by using its ID.

curl --request DELETE \
     --url https://api.yepic.ai/v1/avatars/31811055-83c9-47ef-a762-b75d5882665c \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'

{}

📌 Need help?

If you require assistance or encounter any issues, we recommend referring to our FAQ page first. If you are still unable to resolve your issue, please don't hesitate to contact us for further support.