v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

Submit Task

Submit an async Instant Voice Clone task and receive taskId. Poll the query endpoint for final result.

V1 constraints:

model supports Index TTS and Fish Audio S2 Pro
referenceAudioFileId must point to a wav audio file
output audio format is mp3

Note: Fish Audio S2 Pro does not support emotion params (emotionMode / emotionVector / emotionText).

post/v1/instant_voice_clone/task/submit

Headers

Topview-Uidstring required

User ID

Authorizationstring required

API key, format: Bearer {apiKey}

Request body

model'Index TTS' | 'Fish Audio S2 Pro' required

Display model name (required). Allowed values: Index TTS, Fish Audio S2 Pro

textstring required

Voice script text (required)

referenceAudioFileIdstring required

Reference audio fileId (required), must be wav

emotionMode'slider' | 'prompt'

Emotion mode (optional): slider or prompt. Supported by Index TTS only

emotionVectorstring

Slider emotion vector (optional). Required when emotionMode=slider

emotionTextstring

Prompt emotion text (optional). Required when emotionMode=prompt

boardIdstring

Board ID (optional)

noticeUrlstring

Task completion callback URL (optional)

Example request

{
  "model": "Index TTS",
  "text": "Hello, welcome to Topview.",
  "referenceAudioFileId": "file_abc123",
  "emotionMode": "slider",
  "noticeUrl": "https://example.com/topview/callback"
}

Response

Accepted

codestring

messagestring

Example response

{
  "code": "200",
  "message": "Success",
  "result": {
    "status": "success"
  }
}