Add Looks to Photo Avatar Group
POST
https://api.konpro.ai/v1/photo_avatar/avatar_group/addAdd new looks to an existing photo avatar group by submitting additional avatar images. This allows you to expand the avatar group with more appearance variations.
Request History
Log in to see full request history
| TIME | STATUS | USER AGENT |
|---|---|---|
| Make a request to see history. | ||
0 Requests This Month
cURL Request
shell
curl --request POST \
--url https://api.konpro.ai/v1/photo_avatar/avatar_group/add \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
"group_id": "avatarGroup123",
"image_keys": ["imgKey1", "imgKey2"],
"name": "Winter Collection",
"generation_id": "genId456"
}'Request Body Parameters
| Field | Type | Description |
|---|---|---|
| group_id | string | Identifier of the avatar group to which new looks will be added |
| image_keys | array[string] | List of image keys to add to the group (maximum of 4 per request) |
| name | string | Name describing the new looks being added |
| generation_id | string | (Optional) ID of the generation process used for these images; required if images are generated, optional if uploaded |
Response
Response Structure
Confirms successful addition of looks or returns error details if the operation fails.
Sample Successful Response
json
{
"group_id": "avatarGroup123",
"added_images": [
{
"image_key": "imgKey1",
"status": "added"
},
{
"image_key": "imgKey2",
"status": "added"
}
],
"name": "Winter Collection",
"generation_id": "genId456",
"status": "success",
"message": "Looks added successfully to avatar group"
}Notes
- Requires API authentication.
- The group_id must reference an existing avatar group.
- Maximum of 4 image keys can be added per request.
- All image keys must be valid and accessible.
- Refer to Error Responses for error information.
Example Usage
Shell
curl --request POST \
--url https://api.konpro.ai/v1/photo_avatar/avatar_group/add \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
"group_id": "avatarGroup123",
"image_keys": ["imgKey1", "imgKey2"],
"name": "Winter Collection",
"generation_id": "genId456"
}'LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request
LANGUAGE
CREDENTIALS
HEADER
RESPONSE
Examples
Choose an example:
application/json
200 - Success
400 - Bad Request