Skip to main content
POST
Upload Streaming Avatar
The resources (image, video, voice) generated by our API are valid for 7 days. Please save the relevant resources as soon as possible to prevent expiration.

Authorizations

x-api-key
string
header
required

Your API Key used for request authorization. If both Authorization and x-api-key have values, Authorization will be used first and x-api-key will be discarded.

Body

application/json
url
string
required

Avatar resource link. It is recommended that the video be about one minute long, and the avatar in the video content should rotate at a small angle and be clear.

avatar_id
string
required

Avatar unique ID, can only contain alphanumeric characters

Pattern: ^[a-zA-Z0-9]+$
name
string
required

Avatar display name for easier identification and management

type
enum<integer>
required

Avatar type 2 represents stream avatar. When type is 2, you need to wait until status is 3 before you can use it. You can get the current status in real time through the Get Avatar Detail API.

Available options:
2
url_from
enum<integer>
required

URL source, 1 means akool and other links, 2 means other third-party links (currently only supports YouTube / TikTok / X / Google Drive)

Available options:
1,
2

Response

200 - application/json

Avatar created successfully

code
integer
required

Interface returns business status code (1000: success)

Example:

1000

msg
string
required

Interface returns status information

Example:

"OK"

data
object