API Integration

Prerequisites

Generate Signature & Obtain access_token

To integrate with the Digital Human Open Platform, you must generate a signature and call APIs to obtain an access_token.

How to Obtain access_token (opens new window)

1. Account Benefits

Endpoint：

/openapi/user/v2/get?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

HTTP Method：GET

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Query customer account benefits.

Request Parameters：

None

Response Parameters：

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	Y	Response data
user	Json	Y	User info
id	Integer	Y	User ID
corpId	Integer	Y	Enterprise ID
account	Json	Y	Account info
fastTrainingAmount	Long	Y	Remaining rapid avatar cloning attempts
totalFastTrainingAmount	Long	Y	Total rapid avatar cloning attempts
voiceCloneAmount	Long	Y	Remaining rapid voice cloning attempts
totalVoiceCloneAmount	Long	Y	Total rapid voice cloning attempts
fastDuration	Long	Y	Remaining video synthesis duration (ms)
totalFastDuration	Long	Y	Total video synthesis duration (ms)
ttsWordsAmount	Long	Y	Remaining TTS character quota
totalTtsWordsAmount	Long	Y	Total TTS character quota

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "user": {
            "id": 1005103,
            "corpId": 1004892
        },
        "account": {
            "fastTrainingAmount": 3,
            "totalFastTrainingAmount": 5,
            "voiceCloneAmount": 0,
            "totalVoiceCloneAmount": 0,
            "ttsWordsAmount": 969,
            "totalTtsWordsAmount": 1000,
            "fastDuration": 4894626,
            "totalFastDuration": 20000
        }
    }
}

2. Public Avatars & Voices

2.1 Public Avatar List

Endpoint：

/openapi/robot/v2/fastPublicPageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Query public digital human avatars.

Request Parameters：

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size
name	String	N	Avatar name filter

Response Parameters：

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Avatar list
id	Integer	Y	Scene ID (used as sceneId in video synthesis)
sceneName	String	N	Scene name
coverUrl	String	N	Cover image URL
resolution	String	N	Resolution (e.g., 1080x1920)

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 1,
        "records": [
            {
                "id": -292,
                "sceneName": "test",
                "coverUrl": "http://127.0.0.1/images/test.jpg",
                "resolution": "1080x1920"
            }
        ]
    }
}

2.2 Public Voice List

Endpoint：

/openapi/speaker/v2/fastPublicPageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Query public voice templates.

Request Parameters:

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size
name	String	N	Voice name filter
sex	Integer	N	Gender (1: Male, 2: Female)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Voice list
speakerId	String	Y	Voice ID
ttsName	String	N	Voice name
ttsFeatures	String	N	Voice characteristics
audioUrl	String	N	Sample audio URL
ttsAudition	String	N	Demo audio URL
languages	String	N	Supported languages
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 10,
        "records": [
            {
                "speakerId": "C_173",
                "ttsName": "test",
                "ttsFeatures": "Calm|Magnetic|Gentle",
                "ttsAudition": "http://127.0.0.1/wavs/500806libai.wav",
                "languages": [
                    "zh"
                ],
                "sex": 1,
                "status": 2
            }
        ]
    }
}

3. Rapid Avatar Cloning

3.1 Rapid Avatar Cloning

Endpoint：

/openapi/video/v3/create/training?access_token=ae4dad61-0dc5-47ad-be20c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Submit a rapid avatar cloning task.

Request Parameters:

Field	Type	Required	Remarks
id	Integer	N	Training ID (empty for new tasks)
name	String	Y	Avatar name
videoUrl	String	Y	Training video URL
authorizeUrl	String	Y	Authorize video URL
authorizeText	String	Y	Authorize video speaking text content
level	Integer	Y	Package tier (1: Rapid Avatar Cloning)
compress	boolean	N	Enable video compression
callbackUrl	String	N	Callback URL for task status updates

Authorize video speaking text content:"I am XXX (real name). I consent guiji clone my avatar for the synthesis of video.
Authorization Statement:Clone subject name and authorized subject company as variable parameters.

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	Y	Response data
trainingId	Integer	Y	Training ID

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "trainingId": 181
    }
}

3.2 Avatar Cloning Callback

Endpoint：

User-provided callbackUrl in the cloning request.

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Callback to notify the client of the avatar cloning result.

Request Parameters:

Field	Type	Required	Remarks
taskType	String	Y	video-training for avatar cloning
data	Json	Y	Result details
id	Integer	Y	Training ID
result	String	Y	success or fail
reason	String	N	Failure reason
title	String	N	title
sceneId	String	Y	sceneId
coverUrl	String	N	Cover image URL
authorizeStatus	Integer	N	Authorize status 0 no 1 yes

Example：

{
    "taskType": "video-training",
    "data": {
        "result": "success",
        "coverUrl": "http://127.0.0.1/1898919683985883136.png",
        "reason": "",
        "createTime": 1741572705000,
        "sceneId": -287,
        "updateTime": 1741572739000,
        "id": 423,
        "title": "test"
    }
}

Client Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description

Example：

{
    "code": "0",
   "success": true,
    "message": "Request successful"
}

3.3 Rapid Avatar Cloning List

Endpoint： /openapi/video/v2/training/pageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Paginated list of avatar cloning tasks.

Request Parameters:

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Avatar list
id	Integer	Y	ID
title	String	Y	title
videoUrl	String	Y	Training video URL
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Rejected)
callbackStatus	Integer	Y	Callback status (0: Initial, 1: Success, 2: Failed)
comment	String	Y	Remarks
sceneId	Integer	Y	Scene ID
coverUrl	String	Y	Cover image URL
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
createTime	String	Y	createTime
updateTime	String	Y	updateTime

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 2,
        "records": [
            {
                "id": 423,
                "title": "test",
                "videoUrl": "http://127.0.0.1/videos/pc_1738894568491_2.6.mp4",
                "status": 2,
                "callbackStatus": 2,
                "comment": "",
                "sceneId": -287,
                "createTime": "2025-03-10 10:11:45",
                "updateTime": "2025-03-10 10:16:24",
                "coverUrl": "http://127.0.0.1/images/1898919683985883136.png"
            }
        ]
    }
}

3.4 Get Avatar Cloning Details

Endpoint： /openapi/video/v2/training/get/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：GET

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Retrieve details of a specific avatar cloning task.

Request Parameters:

Field	Type	Required	Remarks
id	Integer	Y	Training ID， (path parameter)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
id	Integer	Y	ID
title	String	Y	title
videoUrl	String	Y	Training video URL
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Rejected)
callbackStatus	Integer	Y	Callback status (0: Initial, 1: Success, 2: Failed)
comment	String	Y	Remarks
sceneId	Integer	Y	Scene ID
coverUrl	String	Y	Cover image URL
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
createTime	String	Y	createTime
updateTime	String	Y	updateTime

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "id": 423,
        "title": "test",
         "videoUrl": "http://127.0.0.1/videos/pc_1738894568491_2.6.mp4",
         "status": 2,
         "callbackStatus": 2,
         "comment": "",
         "sceneId": -287,
         "createTime": "2025-03-10 10:11:45",
         "updateTime": "2025-03-10 10:16:24",
         "coverUrl": "http://127.0.0.1/images/1898919683985883136.png"
     }
 }

4. Rapid Voice Cloning

4.1 Rapid Voice Cloning

Endpoint：

/openapi/speaker/v3/clone?access_token=ae4dad61-0dc5-47ad-be20c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Retrieve details of a specific avatar cloning task.

Request Parameters:

Field	Type	Required	Remarks
name	String	Y	Voice name filter
audioUrl	String	Y	Sample audio URL(WAV format only)
authorizeUrl	String	Y	Authorize audio URL
authorizeText	String	Y	Authorize audio speaking text content
sex	Integer	N	Gender (1: Male, 2: Female)
callbackUrl	String	N	Callback URL for task status updates

We recommend that the audio material you provide meets the following specifications:

category	suggestion
Audio duration	Suggest audio for 10s~30s.
Recording environment	The selection of recording environment mainly considers reducing noise and reverberation. It is recommended to use a small room within 10 square meters for recording, and a room with sound-absorbing devices is an ideal environment.Low cost sound-absorbing cotton can be used to renovate the room, with the aim of changing the planar reflection of sound waves to diffuse reflection and reducing reverberation. 1. Try to record in the same acoustic environment as much as possible, avoiding overly noisy background sounds and noise. The audio should not be pieced together. 2. Avoid recording in far-field environments. It is recommended to be within 50cm of the microphone and maintain a stable position and distance to prevent inconsistent volume levels. Do not direct the airflow of the speaker directly towards the microphone to prevent noise caused by the microphone spraying. 3. Try to record in a natural dialogue state, and the tone obtained by deliberately lowering the voice/whispering will be more in line with the person.
Audio quality	1. It is necessary to have only one person speaking and avoid multiple people speaking at the same time. 2.The clearer the speaker's pronunciation and sound quality, the higher the quality of the reproduction. If the speaker's throat/voice noise is severe, the replicated audio throat and noise will be more severe. 3.When recording, it is necessary to maintain the volume level, stable speech speed, pay attention to sentence breaks, avoid oral noise (such as mouth sounds), murmurs, reverberations, and other situations. Incorporate appropriate interpretation based on the final usage scenario and character design, avoid excessive reading style, and maintain overall consistency in style. 4.When recording, try to maintain a stable posture and reduce unnecessary body movements. The sound of chairs, the friction of clothing, and the typing of mouse and keyboard are common artificial noises that require extra attention to details. 5.If there is a slip of the tongue, there is no need to terminate the recording. You can pause for 1-2 seconds and then continue recording. All the text in the copy does not need to be completed word for word, it is acceptable to throw or fill in words, and keep the sentence clear.
Recording content	It is recommended to familiarize oneself with the script and determine the character design and performance style before recording. Try to be as close to the content and theme of the replica as possible, avoiding the speaker's rhythm being too flat, otherwise a flatter replica effect will be obtained. If you need to reproduce audio with strong emotional and rhythmic fluctuations, please try to input audio with strong expressive power. Try not to replicate the audio of children or elderly people as much as possible.

Authorize audio speaking text content:"I am XXX (real name). I consent guiji clone my voice for the synthesis of audio.
Authorization Statement:Clone subject name and authorized subject company as variable parameters.

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
speakerId	String	Y	Voice ID
ttsName	String	N	Voice name filter
ttsFeatures	String	N	Voice characteristics
audioUrl	String	N	Sample audio URL
ttsAudition	String	N	Demo audio URL
languages	Array	N	Supported languages
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	N	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
reason	String	N	Failure reason
expireTime	String	N	expireTime

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "speakerId": "C_125",
        "ttsName": "tts-clone-test",
        "ttsFeatures": "Original timbre",
        "audioUrl": "https://localhost/test.wav",
        "ttsAudition": "",
        "languages": [
            "zh",
            "en"
        ],
        "sex": null,
        "status": 0,
        "reason": null,
        "expireTime": null
    }
}

4.2 Voice Cloning Callback

Endpoint：

User-provided callbackUrl in the cloning request.

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Callback to notify the client of the voice cloning result.

Request Parameters:

Field	Type	Required	Remarks
taskType	String	Y	voice-clone for voice cloning
data	Json	Y	JSONObject
speakerId	String	Y	Voice ID
result	String	Y	success or fail
reason	String	N	Failure reason
ttsName	String	N	Voice name filter
ttsFeatures	String	N	Voice characteristics
audioUrl	String	N	Sample audio URL
ttsAudition	String	N	Demo audio URL
languages	Array	N	Supported languages
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
expireTime	String	N	expireTime

Example：

{
    "taskType": "voice-clone",
    "data": {
        "ttsName": "tts-clone-test",
        "result": "success",
        "audioUrl": "https://localhost/81aba4874293ee4eff4.wav",
        "expireTime": "2025-12-02 10:38:14",
        "languages": [
            "zh",
            "en"
        ],
        "speakerId": "C_126",
        "ttsFeatures": "Original timbre",
        "ttsAudition": "https://localhost/1E9uN4NJnoBJ.wav",
        "status": 2
    }
}

Client Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description

Example：

{
    "code": "0",
   "success": true,
    "message": "Request successful"
}

4.3 Rapid Voice Cloning List

Endpoint： /openapi/speaker/v2/clonePageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Paginated list of Rapid Voice Cloning tasks.

Request Parameters:

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	N	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)
expireStartTime	String	N	Expiry start time (format: yyyy-MM-dd HH:mm:ss)
expireEndTime	String	N	Expiry end time (format: yyyy-MM-dd HH:mm:ss)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Avatar list
speakerId	String	Y	Voice ID
ttsName	String	N	Voice name filter
ttsFeatures	String	N	Voice characteristics
audioUrl	String	N	Demo audio URL
ttsAudition	String	N	Demo audio URL
languages	Array	N	Supported languages
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
reason	String	N	Failure reason
expireTime	String	N	expireTime

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 2,
        "pageNo": 1,
        "totalRecord": 124,
        "records": [
            {
                "speakerId": "C_125",
                "ttsName": "tts-clone-test",
                "ttsFeatures": "Original timbre",
                "audioUrl": "https://localhost/test-ff4.wav",
                "ttsAudition": "https://localhost/3S6mp9H.wav",
                "languages": [
                    "zh",
                    "en"
                ],
                "sex": null,
                "status": 2,
                "reason": null,
                "expireTime": "2025-12-02 09:39:35"
            }
        ]
    }
}

4.4 Get Rapid Voice Cloning Details

Endpoint：

/openapi/speaker/v2/clone/{speakerId}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：GET

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Retrieve details of a specific Rapid Voice Cloning task.

Request Parameters:

Field	Type	Required	Remarks
speakerId	String	Y	Voice ID， (path parameter)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
speakerId	String	Y	Voice ID
ttsName	String	N	Voice name filter
ttsFeatures	String	N	Voice characteristics
audioUrl	String	N	Demo audio URL
ttsAudition	String	N	Demo audio URL
languages	Array	N	Supported languages
sex	Integer	N	Gender (1: Male, 2: Female)
status	Integer	Y	Status (0: Pending, 1: Training, 2: Success, 3: Failed, 4: Expired)
authorizeStatus	Integer	Y	Authorize status 0 no 1 yes
reason	String	N	Failure reason
expireTime	String	N	expireTime

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "speakerId": "C_122",
        "ttsName": "tts-clone-test",
        "ttsFeatures": "Original timbre",
        "audioUrl": "https://localhost/93ee4eff4.wav",
        "ttsAudition": "https://localhost/WCSWhvXX51.wav",
        "languages": [
            "zh",
            "en"
        ],
        "sex": null,
        "status": 2,
        "reason": null,
        "expireTime": "2025-11-28 09:50:06"
    }
}

5. Video Synthesis

5.1 Video Synthesis

Endpoint：

/openapi/video/v3/simpleCreate?access_token=ae4dad61-0dc5-47ade20c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Submit a digital human video synthesis task.

Request Parameters:

Field	Type	Required	Remarks
videoName	String	N	Scene name
sceneId	String	Y	Scene ID
audioUrl	String	N	Audio URL (priority if provided)
text	String	N	Text for TTS (used if audioUrl is empty)
speakerId	String	N	Voice ID (required if text is used)
pn	Integer	N	Loop direction (0: Forward, 1: Reverse)
callbackUrl	String	N	Callback URL for task status updates

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
videoId	Integer	Y	Scene ID (used as sceneId in video synthesis)

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "videoId": -42
    }
}

5.2 Video Synthesis Callback

Endpoint：

User-provided callbackUrl in the synthesis request.

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Callback to notify the client of the video synthesis result.

Request Parameters:

Field	Type	Required	Remarks
taskType	String	Y	video-synthesis for video tasks
data	Json	Y	JSONObject
id	Integer	Y	Scene ID (used as sceneId in video synthesis)
videoName	String	N	Scene name
result	String	Y	success or fail
failReason	String	N	Failure reason
videoUrl	String	N	Synthesized video URL
duration	String	N	Duration (seconds)
coverUrl	String	N	Cover image URL
createTime	Long	N	createTime
updateTime	Long	N	updateTime

Example：

{
    "taskType": "video-synthesis",
    "data": {
        "duration": "22.75",
        "coverUrl": "http://127.0.0.1/imges/1216229666159992832_capFrame_2_1.jpg",
        "result": "success",
        "videoUrl": "http://127.0.0.1/videos/1216229666159992832_ff_1.mp4",
        "createTime": 1741578148000,
        "level": 1,
        "videoName": "test0310",
        "updateTime": 1741578148000,
        "id": -292,
        "synthesisStatus": 3
    }
}

Client Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description

Example：

{
    "code": "0",
   "success": true,
    "message": "Request successful"
}

5.3 Video Synthesis List

Endpoint：

/openapi/video/v2/pageList?access_token=55d1bc37-f960-4a9d-8c7d-5dc8c991c245

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Paginated list of user video synthesis tasks.

Request Parameters:

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Avatar list
id	Integer	Y	Scene ID (used as sceneId in video synthesis)
videoName	String	N	Scene name
videoFormat	String	N	Video format
synthesisStatus	Integer	N	Synthesis status: -1. Editing, 1. Queued, 2. Processing, 3: Success, 4: Failed, 6. Canceled, 7: Task failed
videoUrl	String	N	Synthesized video URL
srtUrl	String	N	Subtitle file URL
duration	String	N	Duration (seconds)
durationMs	String	N	Duration (milliseconds)
coverUrl	String	N	Cover image URL
createTime	String	N	createTime
updateTime	String	N	updateTime
failReason	String	N	Failure reason

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 10,
        "pageNo": 1,
        "totalRecord": 29,
        "records": [
            {
                "id": -291,
                "videoName": "test",
                "videoFormat": "mp4",
                "duration": "6.966",
                "durationMs": "6966",
                "coverUrl": "http://127.0.0.1/images/1741576636734.jpg",
                "videoUrl": "http://127.0.0.1/videos/1216222911489253376_ff_1.mp4",
                "srtUrl": "http://127.0.0.1/srts/VgAK5CxgtzBkBsR7.srt",
                "synthesisStatus": 3,
                "failReason": null,
                "createTime": "2025-03-10 11:15:33",
                "updateTime": "2025-03-10 11:17:17"
            }
        ]
    }
}

5.4 Video Synthesis Details

Endpoint：

/openapi/video/v2/get/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：GET

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Query user Video Synthesis details.

Request Parameters:

Field	Type	Required	Remarks
id	Integer	Y	Video Synthesisid， (path parameter)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
id	Integer	Y	Scene ID (used as sceneId in video synthesis)
videoName	String	N	Scene name
videoFormat	String	N	Video format
synthesisStatus	Integer	N	Synthesis status: -1. Editing, 1. Queued, 2. Processing, 3: Success, 4: Failed, 6. Canceled, 7: Task failed
videoUrl	String	N	Synthesized video URL
srtUrl	String	N	Subtitle file URL
duration	String	N	Duration (seconds)
durationMs	String	N	Duration (milliseconds)
coverUrl	String	N	Cover image URL
createTime	String	N	createTime
updateTime	String	N	updateTime
failReason	String	N	Failure reason

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "id": -291,
        "videoName": "test",
        "videoFormat": "mp4",
        "duration": "6.966",
        "durationMs": "6966",
        "coverUrl": "http://127.0.0.1/images/1741576636734.jpg",
        "videoUrl": "http://127.0.0.1/videos/1216222911489253376_ff_1.mp4",
        "srtUrl": "http://127.0.0.1/srts/VgAK5CxgtzBkBsR7.srt",
        "synthesisStatus": 3,
        "failReason": null,
        "createTime": "2025-03-10 11:15:33",
        "updateTime": "2025-03-10 11:17:17"
    }
}

6. Audio Synthesis

6.1 Audio Synthesis

Endpoint：

/openapi/speaker/v3/fastTts?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Provides audio synthesis capabilities.

Request Parameters:

Field	Type	Required	Remarks
speakerId	String	Y	Voice ID
content	String	Y	Text content
callbackUrl	String	N	Callback URL for task status updates

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
id	Integer	Y	Audio Synthesisid
status	Integer	Y	Status: 0-Preparing, 1-Processing, 2-Success, 3-Failed

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "id": 202,
        "status": 0
    }
}

6.2 Audio Synthesis Callback

Endpoint：

Callback URL specified in user's audio synthesis request

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

otifies clients of audio synthesis results through platform callback.

Request Parameters:

Field	Type	Required	Remarks
taskType	String	Y	Must be "tts-synthesis" for audio synthesis callback
data	Json	Y	JSONObject
id	Integer	Y	Audio Synthesisid
status	Integer	N	Status: 0-Preparing, 1-Processing, 2-Success, 3-Failed
duration	Integer	Y	Audio duration (milliseconds)
ttsUrl	String	Y	Audio file URL

Example：

{
    "taskType": "tts-synthesis",
    "data": {
        "duration": 0,
        "ttsUrl": "http://127.0.0.1/wav/1.wav",
        "id": 1,
        "status": 2
    }
}

Client Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description

Example：

{
    "code": "0",
   "success": true,
    "message": "Request successful"
}

6.3 Audio Synthesis List

Endpoint：

/openapi/speaker/v2/tts/pageList?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Paged query for user's audio synthesis list.

Request Parameters:

Field	Type	Required	Remarks
page	Integer	Y	Page number
size	Integer	Y	Page size

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
pageSize	Integer	N	Page size
pageNo	Integer	N	Page number
totalRecord	Integer	N	Total records
records	List	N	Avatar list
id	Integer	Y	Audio Synthesisid
status	Integer	N	Status: 0-Preparing, 1-Processing, 2-Success, 3-Failed
duration	Integer	N	Audio duration (milliseconds)
ttsUrl	String	N	Audio file URL
srtUrl	String	N	Subtitle file URL

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "pageSize": 100,
        "pageNo": 1,
        "totalRecord": 2,
        "records": [
            {
                "id": 20,
                "ttsUrl": "http://127.0.0.1/1105667226071080960.wav",
                "srtUrl": "http://127.0.0.1/1105667226071080960.srt",
                "duration": 1539,
                "status": 2
            },
            {
                "id": 19,
                "ttsUrl": "http://127.0.0.1/1105667111205871616.wav",
                "srtUrl": "http://127.0.0.1/1105667111205871616.srt",
                "duration": 601,
                "status": 2
            }
        ]
    }
}

6.4 Audio Synthesis Details

Endpoint：

/openapi/speaker/v2/tts/{id}?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：GET

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Query user's audio synthesis details.

Request Parameters:

Field	Type	Required	Remarks
id	Integer	Y	Audio Synthesisid， (path parameter)

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Json	N	Response data
id	Integer	Y	Audio Synthesisid
status	Integer	N	Status: 0-Preparing, 1-Processing, 2-Success, 3-Failed
duration	Integer	N	Audio duration (milliseconds)
ttsUrl	String	N	Audio file URL
srtUrl	String	N	Subtitle file URL

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": {
        "id": 17,
        "ttsUrl": "http://127.0.0.1/1104702054431072256.wav",
        "srtUrl": "http://127.0.0.1/1104702054431072256.srt",
        "duration": 2012,
        "status": 2
    }
}

7. Historical cloning data authorization

7.1 Historical Image Authorization

Endpoint：

/openapi/video/v3/authorize?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Historical image authorization. Please use the 3.4 interface to check whether the specific authorization verification is successful or not.

Request Parameters:

Field	Type	Required	Remarks
sceneId	Integer	Y	Scene ID
authorizeUrl	String	Y	Authorize video url
authorizeText	String	Y	Authorize video speaking text content

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Boolean	N	Response data

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": true
}

7.2 Historical Audio Authorization

Endpoint：

/openapi/speaker/v3/authorize?access_token=ae4dad61-0dc5-47ad-be20-c51245db2769

HTTP Method：POST

Request Content-Type：application/json

Response Content-Type：application/json

Description：

Historical audio authorization. Please use the 4.4 interface to check whether the specific authorization verification is successful or not.

Request Parameters:

Field	Type	Required	Remarks
speakerId	String	Y	Voice ID
authorizeUrl	String	Y	Authorize audio url
authorizeText	String	Y	Authorize audio speaking text content

Response Parameters:

Field	Type	Required	Remarks
code	String	Y	Status code (0 = success)
success	Boolean	Y	Success/Error
message	String	Y	Result description
data	Boolean	N	Response data

Example：

{
    "code": "0",
    "message": "Request successful",
    "success": true,
    "data": true
}