Image Upload
Passing in an image as a character with this method can greatly reduce the time required to create a character. The image will be automatically deleted after 90 days.
API Overview
| Method | HTTP Request | Description |
|---|---|---|
| Create | POST /live/v1/avatars | Create character asset |
| Get | GET /live/v1/avatars/{id} | Retrieve a single character asset |
| Delete | DELETE /live/v1/avatars/{id} | Delete character asset |
| List | GET /live/v1/avatars | Paginated list query |
2. Create Character Asset Request Example
Request Parameters
image_uristringThe image of the character. Supports public URLs and base64. Only 1 image (single person) is supported; full-body / half-body and various styles are supported. Format: PNG / JPG / JPEG / WEBP; image size ≤ 50MB; byte length after base64 decode < 20M, and a content type prefix must be included, for example data:image/png;base64,{base64_encode}
namestringOptionalOptional display name; empty if not provided
Response Parameters
idstringCharacter asset ID (can be passed as avatar.id)
image_uristringAccess URL of the character image
namestringDisplay name
statusstringDescribes the generation status. See "status Enum" below for valid values.
created_attimestampCreation time
updated_attimestampUpdate time
status Enum
| Value | Meaning |
|---|---|
| created (1) | Created, waiting for description generation |
| processing (6) | Generating description |
| success (11) | Generation succeeded |
| failed (12) | Generation failed (final state; re-creation required) |
3. Retrieve a Character Asset
4. Delete Character Asset
List Query
pager.pageintegerPage number, starting from 0. Default: 0
pager.pageszintegerNumber of items per page. Default: 10, maximum: 100