{"info":{"_postman_id":"bb0b6bea-bcd2-470c-9d60-3ddb6ad138f2","name":"DeepZen Text-To-Speech API","description":"

DeepZen Text-To-Speech API is a private API. Please send a request for access by contacting us via developers@deepzen.io.

Authorization

Once you have your access tokens, you should pass it with all of your requests using Authorization header like this:

Authorization: ApiToken {YOUR_TOKEN}\n\n

Concepts

Jobs & Webhooks

All synthesis requests return a Job ID. It's a good practice to provide webhook_url for all long synthesis requests to avoid possible timeout. Provided webhook_url will be called with the output of the job and the job ID that you get when you call the endpoint.

Validation errors will be returned immediately when you call an endpoint. If you don't provide a webhook url, HTTP request will be held until synthesis completes and job success output is returned immediately.

Available Voices

As we continuously license more voices, they will be made available here. Below is a list of available voices:

US Male: edward, todd
US Female: kellie, dahlia, zoe , cora, jen-austin
Alfro-American Accent: joe
UK Male: william
UK Female: alice, lauren, elaine
French Male: sylvain, cedric
French Female: melissa
German Male: david, otto, ben
German Female: anja
Turkish Male: emrah
Turkish Female: basak
Mexican Male: santiago
Mexican Female: sabrina

Emotion Control

One of 7 emotions and corresponding intensities can be selected at synthesis time.

Emotions: anger, disgust, excited, fear, happy, sad, surprise.
Intensity: low, medium, high.

Note: Every voice is unique, hence their emotional intensities will differ.

SSML

ssml flag must be set to true for SSML tags to work (see sample code from Create Session). The speak tag is the root element. All SSML-enhanced text must be enclosed by a pair of opening and closing speak tags (see sample code from Create Session) although we omit them in some of the examples given below. Apart from the root tag, supported elements are:

p paragraph tag:
This is a paragraph.
s sentence tag, this is equivalent to ending a sentence with a period (.):
~~This is a sentence~~
sub substitution tag used with attribute alias to substitute a different word:
Hg
break tag used with attribute strength to specify a pause. Accepted strength values are:
none, weak, medium, strong, extra-long:
A little lamb whose fleece was grey
phoneme tag used with attribute ph specifies the pronunciation using International Phonetic Alphabet (IPA) alphabet (stress mark must be after the vowel):
pecan
emphasis tag used with level attribute: none, medium, strong:
really
say-as tag used with attribute interpret-as to interpret non-standard words. Accepted categories are: spell-out (initialisms), digits (also spelled out), ordinal, cardinal, year:
1900
mark tag used with attribute name to retrieve a time-stamp on given text location:
A little lamb

The output payload will contain a dict marks: {\"end\": time in seconds}

Streaming

Optionally for faster response to requests, streaming can be implemented using DeepZen Javascript SDK. This enables the voice to start streaming before the synthesis is completed. The public repository is located here: https://bitbucket.org/deepzenio/sdk-js/ Please refer to README and examples for details.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorization","slug":"authorization"},{"content":"Concepts","slug":"concepts"}],"owner":"32143694","collectionId":"bb0b6bea-bcd2-470c-9d60-3ddb6ad138f2","publishedId":"2s9YsGhszG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0096FF"},"publishDate":"2024-01-04T23:16:43.000Z"},"item":[{"name":"List Sessions","id":"e97c5abe-258b-444f-a694-e6dd7ceec7e8","request":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/sessions/","description":"

Returns a list of all historical sessions.

\n","urlObject":{"path":["v1","sessions",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4737a5df-b10f-48e0-802c-55f5c835520e","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"https://api.deepzen.io/v1/sessions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:19:55 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"28528"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": \"http://localhost:50967/v1/sessions/?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"bce040c0-310f-4800-beb3-528bcc2f3741\",\n \"text\": \"This is a different text.\",\n \"preset\": null,\n \"voice\": \"william\",\n \"rendered_at\": null,\n \"synthesis_json\": null,\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"visemes\": [\n [\n 0,\n 0.025,\n \"#\"\n ],\n [\n 0.025,\n 0.1,\n \"T\"\n ],\n [\n 0.1,\n 0.155,\n \"i\"\n ],\n [\n 0.155,\n 0.379,\n \"s\"\n ],\n [\n 0.379,\n 0.87,\n \"i\"\n ],\n [\n 0.87,\n 0.98,\n \"s\"\n ],\n [\n 0.98,\n 1.116,\n \"@\"\n ],\n [\n 1.116,\n 1.18,\n \"t\"\n ],\n [\n 1.18,\n 1.24,\n \"i\"\n ],\n [\n 1.24,\n 1.28,\n \"f\"\n ],\n [\n 1.28,\n 1.345,\n \"r\"\n ],\n [\n 1.345,\n 1.385,\n \"@\"\n ],\n [\n 1.385,\n 1.615,\n \"t\"\n ],\n [\n 1.615,\n 1.7,\n \"E\"\n ],\n [\n 1.7,\n 1.81,\n \"k\"\n ],\n [\n 1.81,\n 2,\n \"s\"\n ],\n [\n 2,\n 2.097,\n \"t\"\n ],\n [\n 2.097,\n 3.75,\n \"#\"\n ]\n ],\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a different text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/s1.wav\",\n \"duration\": \"3.75\"\n }\n ],\n \"marks\": {}\n },\n {\n \"id\": \"5eb9ef47-9dd1-420f-ac6a-16f81a6db841\",\n \"text\": \"This is a short text.\",\n \"preset\": null,\n \"voice\": \"alice\",\n \"rendered_at\": null,\n \"synthesis_json\": null,\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"visemes\": [\n [\n 0,\n 0,\n \"#\"\n ],\n [\n 0,\n 0.05,\n \"T\"\n ],\n [\n 0.05,\n 0.1,\n \"i\"\n ],\n [\n 0.1,\n 0.177,\n \"s\"\n ],\n [\n 0.177,\n 0.25,\n \"i\"\n ],\n [\n 0.25,\n 0.32,\n \"s\"\n ],\n [\n 0.32,\n 0.424,\n \"@\"\n ],\n [\n 0.424,\n 0.49,\n \"S\"\n ],\n [\n 0.49,\n 0.595,\n \"O\"\n ],\n [\n 0.595,\n 0.82,\n \"t\"\n ],\n [\n 0.82,\n 0.89,\n \"E\"\n ],\n [\n 0.89,\n 1.01,\n \"k\"\n ],\n [\n 1.01,\n 1.16,\n \"s\"\n ],\n [\n 1.16,\n 1.277,\n \"t\"\n ],\n [\n 1.277,\n 2.91,\n \"#\"\n ]\n ],\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a short text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/s1.wav\",\n \"duration\": \"2.91\"\n }\n ],\n \"marks\": {}\n }\n ]\n}"},{"id":"1ad5866a-b725-4b6b-ae08-48376f90a763","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/sessions/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:21:08 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"86"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"detail\": \"Authentication credentials were not provided.\"\n },\n \"status_code\": 403\n}"}],"_postman_id":"e97c5abe-258b-444f-a694-e6dd7ceec7e8"},{"name":"Create Session","id":"77db2618-7bd9-4893-a8cb-133e786e2f8f","request":{"method":"POST","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sessions\": [\n {\n \"text\": \"This is a short text.\",\n \"voice\": \"alice\"\n },\n {\n \"text\": \"This is a different text.\",\n \"voice\": \"william\",\n \"ssml\": true,\n \"emotion\": {\n \"name\": \"sad\",\n \"intensity\": \"high\"\n }\n }\n ],\n \"webhook_url\": \"http://localhost:3434\"\n}"},"url":"{{base_url}}/v1/sessions/","description":"

The main service to create a new synthesis request. You can send one request or an array of multiple requests. The request will return a Job id that can be used to poll for status (Refer to Job Detail service) for requests that may take longer.

\n","urlObject":{"path":["v1","sessions",""],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f6633a0f-ff09-4a7f-9aec-b7040f14626d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sessions\": [\n {\n \"text\": \"This is a short text.\",\n \"voice\": \"alice\"\n },\n {\n \"text\": \"This is a different text.\",\n \"voice\": \"william\",\n \"ssml\": true,\n \"emotion\": {\n \"name\": \"sad\",\n \"intensity\": \"high\"\n }\n }\n ],\n \"webhook_url\": \"http://localhost:3434\"\n}"},"url":"https://api.deepzen.io/v1/sessions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 19 Apr 2024 16:10:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"129"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"812b1bc6-ad9f-400a-9815-47c4e20ff41f\",\n \"created_at\": \"2024-04-19T16:10:40.174074Z\",\n \"status\": \"fail\",\n \"data\": null,\n \"title\": null\n}"},{"id":"b8a2be06-90ba-4f15-925c-3530bcab68ec","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/sessions/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:21:08 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"86"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"detail\": \"Authentication credentials were not provided.\"\n },\n \"status_code\": 403\n}"}],"_postman_id":"77db2618-7bd9-4893-a8cb-133e786e2f8f"},{"name":"List Jobs","id":"624de1db-5418-43b5-9673-02ff4948210b","request":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/jobs","description":"

This service will return a list of all pending and historical jobs.

\n","urlObject":{"path":["v1","jobs"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"70ba6e04-0866-4d8a-9817-2fca15db44c1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"https://api.deepzen.io/v1/jobs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:23:22 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"30418"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"next\": \"http://localhost:50967/v1/jobs/?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"538bfe9c-5d5d-4198-bc53-ff5313b7abb5\",\n \"created_at\": \"2024-04-19T16:18:45.722693Z\",\n \"status\": \"success\",\n \"data\": [\n {\n \"status\": \"success\",\n \"session\": {\n \"id\": \"5eb9ef47-9dd1-420f-ac6a-16f81a6db841\",\n \"text\": \"This is a short text.\",\n \"marks\": {},\n \"voice\": \"alice\",\n \"preset\": null,\n \"visemes\": [\n [\n 0,\n 0,\n \"#\"\n ],\n [\n 0,\n 0.05,\n \"T\"\n ],\n [\n 0.05,\n 0.1,\n \"i\"\n ],\n [\n 0.1,\n 0.177,\n \"s\"\n ],\n [\n 0.177,\n 0.25,\n \"i\"\n ],\n [\n 0.25,\n 0.32,\n \"s\"\n ],\n [\n 0.32,\n 0.424,\n \"@\"\n ],\n [\n 0.424,\n 0.49,\n \"S\"\n ],\n [\n 0.49,\n 0.595,\n \"O\"\n ],\n [\n 0.595,\n 0.82,\n \"t\"\n ],\n [\n 0.82,\n 0.89,\n \"E\"\n ],\n [\n 0.89,\n 1.01,\n \"k\"\n ],\n [\n 1.01,\n 1.16,\n \"s\"\n ],\n [\n 1.16,\n 1.277,\n \"t\"\n ],\n [\n 1.277,\n 2.91,\n \"#\"\n ]\n ],\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a short text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/s1.wav\",\n \"duration\": \"2.91\"\n }\n ],\n \"rendered_at\": null,\n \"synthesis_json\": null\n }\n },\n {\n \"status\": \"success\",\n \"session\": {\n \"id\": \"bce040c0-310f-4800-beb3-528bcc2f3741\",\n \"text\": \"This is a different text.\",\n \"marks\": {},\n \"voice\": \"william\",\n \"preset\": null,\n \"visemes\": [\n [\n 0,\n 0.025,\n \"#\"\n ],\n [\n 0.025,\n 0.1,\n \"T\"\n ],\n [\n 0.1,\n 0.155,\n \"i\"\n ],\n [\n 0.155,\n 0.379,\n \"s\"\n ],\n [\n 0.379,\n 0.87,\n \"i\"\n ],\n [\n 0.87,\n 0.98,\n \"s\"\n ],\n [\n 0.98,\n 1.116,\n \"@\"\n ],\n [\n 1.116,\n 1.18,\n \"t\"\n ],\n [\n 1.18,\n 1.24,\n \"i\"\n ],\n [\n 1.24,\n 1.28,\n \"f\"\n ],\n [\n 1.28,\n 1.345,\n \"r\"\n ],\n [\n 1.345,\n 1.385,\n \"@\"\n ],\n [\n 1.385,\n 1.615,\n \"t\"\n ],\n [\n 1.615,\n 1.7,\n \"E\"\n ],\n [\n 1.7,\n 1.81,\n \"k\"\n ],\n [\n 1.81,\n 2,\n \"s\"\n ],\n [\n 2,\n 2.097,\n \"t\"\n ],\n [\n 2.097,\n 3.75,\n \"#\"\n ]\n ],\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a different text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/s1.wav\",\n \"duration\": \"3.75\"\n }\n ],\n \"rendered_at\": null,\n \"synthesis_json\": null\n }\n }\n ],\n \"title\": null\n }\n ]\n}"},{"id":"80479338-4cd9-4f7a-98f2-02ca386c4ca2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/sessions/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:21:08 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"86"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"detail\": \"Authentication credentials were not provided.\"\n },\n \"status_code\": 403\n}"}],"_postman_id":"624de1db-5418-43b5-9673-02ff4948210b"},{"name":"Job Detail","id":"42a5fe3f-dca7-4ed5-85fc-149ed3fc0c8c","request":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/jobs/{{job_id}}","description":"

Returns the details and result of a pending or historical job.

\n","urlObject":{"path":["v1","jobs","{{job_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c54794ee-c8e8-42c5-9815-e3744e30eb12","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"https://api.deepzen.io/v1/jobs/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:24:29 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"1921"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"538bfe9c-5d5d-4198-bc53-ff5313b7abb5\",\n \"created_at\": \"2024-04-19T16:18:45.722693Z\",\n \"status\": \"success\",\n \"data\": [\n {\n \"status\": \"success\",\n \"session\": {\n \"id\": \"5eb9ef47-9dd1-420f-ac6a-16f81a6db841\",\n \"text\": \"This is a short text.\",\n \"marks\": {},\n \"voice\": \"alice\",\n \"preset\": null,\n \"visemes\": [\n [\n 0,\n 0,\n \"#\"\n ],\n [\n 0,\n 0.05,\n \"T\"\n ],\n [\n 0.05,\n 0.1,\n \"i\"\n ],\n [\n 0.1,\n 0.177,\n \"s\"\n ],\n [\n 0.177,\n 0.25,\n \"i\"\n ],\n [\n 0.25,\n 0.32,\n \"s\"\n ],\n [\n 0.32,\n 0.424,\n \"@\"\n ],\n [\n 0.424,\n 0.49,\n \"S\"\n ],\n [\n 0.49,\n 0.595,\n \"O\"\n ],\n [\n 0.595,\n 0.82,\n \"t\"\n ],\n [\n 0.82,\n 0.89,\n \"E\"\n ],\n [\n 0.89,\n 1.01,\n \"k\"\n ],\n [\n 1.01,\n 1.16,\n \"s\"\n ],\n [\n 1.16,\n 1.277,\n \"t\"\n ],\n [\n 1.277,\n 2.91,\n \"#\"\n ]\n ],\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a short text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f24f6d6fe6811eead02f2c7adcde3e4/s1.wav\",\n \"duration\": \"2.91\"\n }\n ],\n \"rendered_at\": null,\n \"synthesis_json\": null\n }\n },\n {\n \"status\": \"success\",\n \"session\": {\n \"id\": \"bce040c0-310f-4800-beb3-528bcc2f3741\",\n \"text\": \"This is a different text.\",\n \"marks\": {},\n \"voice\": \"william\",\n \"preset\": null,\n \"visemes\": [\n [\n 0,\n 0.025,\n \"#\"\n ],\n [\n 0.025,\n 0.1,\n \"T\"\n ],\n [\n 0.1,\n 0.155,\n \"i\"\n ],\n [\n 0.155,\n 0.379,\n \"s\"\n ],\n [\n 0.379,\n 0.87,\n \"i\"\n ],\n [\n 0.87,\n 0.98,\n \"s\"\n ],\n [\n 0.98,\n 1.116,\n \"@\"\n ],\n [\n 1.116,\n 1.18,\n \"t\"\n ],\n [\n 1.18,\n 1.24,\n \"i\"\n ],\n [\n 1.24,\n 1.28,\n \"f\"\n ],\n [\n 1.28,\n 1.345,\n \"r\"\n ],\n [\n 1.345,\n 1.385,\n \"@\"\n ],\n [\n 1.385,\n 1.615,\n \"t\"\n ],\n [\n 1.615,\n 1.7,\n \"E\"\n ],\n [\n 1.7,\n 1.81,\n \"k\"\n ],\n [\n 1.81,\n 2,\n \"s\"\n ],\n [\n 2,\n 2.097,\n \"t\"\n ],\n [\n 2.097,\n 3.75,\n \"#\"\n ]\n ],\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_final.wav\",\n \"sentences\": [\n {\n \"id\": \"s1\",\n \"text\": \"This is a different text.\",\n \"wav_url\": \"https://deepzen-tts.s3.us-east-1.amazonaws.com/output/538bfe9c-5d5d-4198-bc53-ff5313b7abb5_7f30fc42fe6811ee836b668636bc7b3d/s1.wav\",\n \"duration\": \"3.75\"\n }\n ],\n \"rendered_at\": null,\n \"synthesis_json\": null\n }\n }\n ],\n \"title\": null\n}"},{"id":"67e35a5a-663d-422b-81ad-a4f8cf11578a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}"}],"url":"{{base_url}}/v1/sessions/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn"},{"key":"Date","value":"Fri, 19 Apr 2024 16:21:08 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"86"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"detail\": \"Authentication credentials were not provided.\"\n },\n \"status_code\": 403\n}"}],"_postman_id":"42a5fe3f-dca7-4ed5-85fc-149ed3fc0c8c"},{"name":"Usage Report","id":"9b5c0f97-52f3-4468-86d7-2baf49f7302d","request":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}","type":"text"}],"url":"{{base_url}}/v1/reports/usage?usage_date=2024-12-11&start_date=2024-12-10&end_date=2024-12-11&narrator=edward","description":"

This API endpoint retrieves usage reports for narrators based on the specified query parameters. It allows you to filter the usage data by usage_date or by a date range (start_date and end_date). You can also filter the data by the specific narrator.

Request Parameters

Query Parameters:

narrator (optional): The name of the narrator for whom the usage data is being retrieved. If omitted, data for all narrators will be returned.
usage_date (optional): A specific date (YYYY-MM-DD) for which the usage data is requested.
start_date and end_date (optional): A date range (YYYY-MM-DD) to retrieve usage data. Both parameters must be provided together.

Validation Rules:

Either usage_date or both start_date and end_date must be provided.
usage_date cannot be used together with start_date and end_date.

Response

results:

total_time: Total time in seconds (aggregated for all narrators or the specified narrator).
\n
total_chars: Total number of characters used.
\n
total_usage_count: Total number of usage instances.
\n
details (only present if no narrator is specified) containing total_time, total_chars, total_usage_count
\n

\n","urlObject":{"path":["v1","reports","usage"],"host":["{{base_url}}"],"query":[{"key":"usage_date","value":"2024-12-11"},{"key":"start_date","value":"2024-12-10"},{"key":"end_date","value":"2024-12-11"},{"key":"narrator","value":"edward"}],"variable":[]}},"response":[{"id":"54a968ed-91de-474b-b2cb-beae6b59d4db","name":"Usage Date Sample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}","type":"text"}],"url":{"raw":"https://api.deepzen.io/v1/reports/usage?usage_date=2024-12-10&narrator=edward","protocol":"https","host":["api","deepzen","io"],"path":["v1","reports","usage"],"query":[{"key":"usage_date","value":"2024-12-10"},{"key":"start_date","value":"2024-12-10","disabled":true},{"key":"end_date","value":"2024-12-11","disabled":true},{"key":"narrator","value":"edward"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jan 2025 21:57:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"allow","value":"GET"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=Pg%2Bgp5RMSQkIQ5Hh6PNzM2vcxpG5hOK%2BQXRCILrK%2BBHc6CDXGaTuH45QonI%2Fw8RVycvOlqmL1Ovn%2FOnHq3USo79mXsLog0IZwMT9PJ51CVIn%2BIooplLAwPd2yPCnK4ck5A%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8fffecac3a63e332-IST"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=20937&min_rtt=17345&rtt_var=7276&sent=514&recv=506&lost=0&retrans=0&sent_bytes=10898&recv_bytes=3781&delivery_rate=315114&cwnd=4&unsent_bytes=0&cid=ded5930a701b1892&ts=504871&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"total_time\": 17.61,\n \"total_chars\": 817,\n \"total_usage_count\": 1\n }\n}"},{"id":"74b7986c-38a6-4c0b-b0c1-9e9ddbe3dba4","name":"Between Dates Sample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}","type":"text"}],"url":{"raw":"https://api.deepzen.io/v1/reports/usage?start_date=2024-12-09&end_date=2024-12-11&narrator=edward","protocol":"https","host":["api","deepzen","io"],"path":["v1","reports","usage"],"query":[{"key":"usage_date","value":"2024-12-10","disabled":true},{"key":"start_date","value":"2024-12-09"},{"key":"end_date","value":"2024-12-11"},{"key":"narrator","value":"edward"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jan 2025 21:58:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"allow","value":"GET"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2BG1dx6UZofZz6vJr%2BiLaDlkWHy1MDWsbo%2FIj5oJpQ7zB1ZKEa%2BpiDEEDk2Qco1Sm5xOxNIEfnCBQ7XbbtZ%2Budnlugyojwiuny18tAHfdHITQI9NVco23MkiC5%2Fv%2BHuNu5w%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8fffed969833e332-IST"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=22719&min_rtt=17345&rtt_var=7189&sent=553&recv=545&lost=0&retrans=0&sent_bytes=12078&recv_bytes=4140&delivery_rate=315114&cwnd=257&unsent_bytes=0&cid=ded5930a701b1892&ts=542360&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"total_time\": 22.49,\n \"total_chars\": 935,\n \"total_usage_count\": 3\n }\n}"},{"id":"f0a36b21-6d23-49e2-81f5-b57e5a491c66","name":"All Narrators Sample","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiToken {{access_token}}","type":"text"}],"url":{"raw":"https://api.deepzen.io/v1/reports/usage?start_date=2024-12-09&end_date=2024-12-11","protocol":"https","host":["api","deepzen","io"],"path":["v1","reports","usage"],"query":[{"key":"usage_date","value":"2024-12-10","disabled":true},{"key":"start_date","value":"2024-12-09"},{"key":"end_date","value":"2024-12-11"},{"key":"narrator","value":"edward","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 10 Jan 2025 21:58:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"allow","value":"GET"},{"key":"x-frame-options","value":"DENY"},{"key":"vary","value":"origin, Cookie"},{"key":"x-content-type-options","value":"nosniff"},{"key":"referrer-policy","value":"same-origin"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=As9zCzzAGRRNlOfRx%2BIZmQNag7lT%2B4QTBAyFOsmefRe7eITVFY0RR3bR0iD%2FGK0l1hGbZvmyjKfhcQb15zW4gBWykwZzY%2BoMd5vDjeqTnbo2bOWXpZUdfW05oADl2qYOEQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains; preload"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8fffee2f0910e332-IST"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=21522&min_rtt=17237&rtt_var=6096&sent=579&recv=571&lost=0&retrans=0&sent_bytes=13261&recv_bytes=4483&delivery_rate=315114&cwnd=257&unsent_bytes=0&cid=ded5930a701b1892&ts=566729&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"results\": {\n \"total_time\": 148262.41,\n \"total_chars\": 7071695,\n \"total_usage_count\": 8275,\n \"details\": {\n \"alice\": {\n \"total_time\": 9805.3,\n \"total_chars\": 496900,\n \"total_usage_count\": 1050\n },\n \"anja\": {\n \"total_time\": 921.42,\n \"total_chars\": 46850,\n \"total_usage_count\": 115\n },\n \"basak\": {\n \"total_time\": 6839.05,\n \"total_chars\": 313945,\n \"total_usage_count\": 340\n },\n \"ben\": {\n \"total_time\": 154.41,\n \"total_chars\": 8479,\n \"total_usage_count\": 14\n },\n \"cedric\": {\n \"total_time\": 2783.64,\n \"total_chars\": 168492,\n \"total_usage_count\": 221\n },\n \"david\": {\n \"total_time\": 80.98,\n \"total_chars\": 4776,\n \"total_usage_count\": 7\n },\n \"edward\": {\n \"total_time\": 22.49,\n \"total_chars\": 935,\n \"total_usage_count\": 3\n },\n \"elaine\": {\n \"total_time\": 64.7,\n \"total_chars\": 3667,\n \"total_usage_count\": 3\n },\n \"emrah\": {\n \"total_time\": 190.31,\n \"total_chars\": 8053,\n \"total_usage_count\": 9\n },\n \"joe\": {\n \"total_time\": 3354.14,\n \"total_chars\": 172281,\n \"total_usage_count\": 328\n },\n \"kellie\": {\n \"total_time\": 3078.02,\n \"total_chars\": 157404,\n \"total_usage_count\": 328\n },\n \"sabrina\": {\n \"total_time\": 1553.11,\n \"total_chars\": 68744,\n \"total_usage_count\": 46\n },\n \"santiago\": {\n \"total_time\": 2399.34,\n \"total_chars\": 134868,\n \"total_usage_count\": 214\n },\n \"sylvain\": {\n \"total_time\": 44.88,\n \"total_chars\": 3090,\n \"total_usage_count\": 2\n },\n \"todd\": {\n \"total_time\": 64.82,\n \"total_chars\": 3475,\n \"total_usage_count\": 3\n },\n \"william\": {\n \"total_time\": 364.57,\n \"total_chars\": 19420,\n \"total_usage_count\": 18\n },\n \"zoe\": {\n \"total_time\": 116541.23,\n \"total_chars\": 5460316,\n \"total_usage_count\": 5574\n }\n }\n }\n}"}],"_postman_id":"9b5c0f97-52f3-4468-86d7-2baf49f7302d"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}]}