获取文本转语音作业数据

开发环境

http://dev-cn.your-api-server.com

GET

/api/v2/tts/ {id}

检索有关异步文本转语音作业的信息。

根据接受标头，API 返回 JSON 格式的作业数据、作业进度的文本事件流或生成的音频文件的字节流。

如果接受标头包含或，端点将使用有关所请求作业的数据进行响应：accept: application/json``accept: */*

地位：200 - OK

Body：作业数据（例如作业状态、进度等）

如果接受标头包含或存在查询参数，它将使用有关作业进度的文本事件流进行响应：accept: text/event-stream``?format=event-stream

地位：200 - OK

正文：提供作业进度更新的事件流

如果接受标头包含或存在查询参数，它将使用生成的音频文件的字节流进行响应：accept: audio/mpeg``?format=audio-mpeg

地位：200 - OK

正文：如果文件不是生成为 MP3，则以 MP3 格式或 HTTP 406 流式传输音频文件。

请求参数

Path 参数

Header 参数

返回响应

🟢200成功

application/json

Body

🟠401没有权限

🟠403禁止访问

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/api/v2/tts/ ' \
--header 'accept;' \
--header 'AUTHORIZATION: YOUR_SECRET_KEY_HERE' \
--header 'X-USER-ID: YOUR_USER_ID_HERE'

响应示例

200 - 成功示例

{
  "id": "f0gZrOKBKL7veJ6o1M",
  "created": "2023-03-04T01:12:03.981Z",
  "input": {
    "text": "Hello! Said the realistic voice.",
    "voice": "s3://voice-cloning-zero-shot/d9ff78ba-d016-47f6-b0ef-dd630f59414e/female-cs/manifest.json",
    "quality": "draft",
    "output_format": "mp3",
    "speed": 1,
    "sample_rate": 24000,
    "seed": null,
    "temperature": null,
    "voice_engine": "PlayHT2.0",
    "emotion": "female_happy",
    "voice_guidance": 3,
    "style_guidance": 20
  },
  "output": {
    "duration": 1.664,
    "size": 35085,
    "url": "https://peregrine-results.s3.amazonaws.com/pigeon/f0gZrOKBKL7veJ6o1M_0.mp3"
  },
  "_links": [
    "{\n  href: 'https://play.ht/api/v2/tts/f0gZrOKBKL7veJ6o1M',\n  method: 'GET',\n  contentType: 'application/json',\n  rel: 'self',\n  description: \"Fetches this job's data. Poll it for the latest status.\",\n}\n"
  ]
}

修改于 2024-04-28 07:27:47

从文本生成音频

列出 PlayHT 音色