Get Text-To-Speech Job Data

Retrieves information about an async text-to-speech job.

Depending on the accept header, the API returns either the job data in JSON format, a text event-stream of the job's progress or a byte stream of the generated audio file.

If the accept header contains accept: application/json or accept: */*, the endpoint responds with data about the requested job:

Status: 200 - OK

Body: the job data (e.g., job status, progress, etc.)

If the accept header contains accept: text/event-stream or the query param ?format=event-stream is present, it responds with a text event-stream about the job progress:

Status: 200 - OK

Body: an event stream that provides updates on the job's progress

If the accept header contains accept: audio/mpeg or the query param ?format=audio-mpeg is present, it responds with a byte stream of the generated audio file:

Status: 200 - OK

Body: streams audio file in the MP3 format or HTTP 406 if the file was not generated as MP3.

{ "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" ] }

Get Text-To-Speech Job Data

Request

Responses