NAV
Curl Javascript

ETX Media Services v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Etx Studio Media Services API documentation

Base URLs:

Authentication

AudioEase

Render a content to audio or video format

Code samples

# You can also use wget
curl -X POST https://dailyup-api-beta.etxstudio.com/audioease \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-api-key: API_KEY'


const inputBody = '{
  "format": "audio",
  "callback": "https://example.com/callback_url",
  "items": [
    {
      "type": "text",
      "text": "The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz prog. Junk MTV quiz graced by fox whelps.",
      "audio": "https://example.com/audiofile.mp3",
      "image": "https://example.com/cute_kittens.jpg",
      "title": "string",
      "voice_id": "fr_fr_female_1"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'x-api-key':'API_KEY'
};

fetch('https://dailyup-api-beta.etxstudio.com/audioease',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /audioease

Will either serve the rendered output or initiate the rendering of the provided content. Will always return the status and an id.

Body parameter

{
  "format": "audio",
  "callback": "https://example.com/callback_url",
  "items": [
    {
      "type": "text",
      "text": "The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz prog. Junk MTV quiz graced by fox whelps.",
      "audio": "https://example.com/audiofile.mp3",
      "image": "https://example.com/cute_kittens.jpg",
      "title": "string",
      "voice_id": "fr_fr_female_1"
    }
  ]
}

Parameters

Name In Type Required Description
body body Input true Content input, to be rendered
» format body string true Desired output format, audio is mp3, video is mp4
» callback body string(uri) false Webhook callback URL to be called at the end of the rendering process.
» items body [InputItem] true none
»» type body string true Item type
»» text body string(ssml) false Text content, required if the item is of text type.
»» audio body string(uri) false Audio file URL, required if the item is of audio type.
»» image body string(uri) false Image URL that will be displayed for this item in the video output.
»» title body string false Text that will be displayed over the item's image in the video output.
»» voice_id body string false Voice identifier that will be used, required if the item is of text type.

Detailed descriptions

» callback: Webhook callback URL to be called at the end of the rendering process. See webhooks for details

»» text: Text content, required if the item is of text type. Accepts SSML tags

»» audio: Audio file URL, required if the item is of audio type. Accepts MP3 format.

»» voice_id: Voice identifier that will be used, required if the item is of text type. See voices for more details

Enumerated Values

Parameter Value
» format audio
» format video
» format video-mobile
»» type text
»» type audio

Example responses

200 Response

{
  "id": "db00fa34-b6b0-4b6b-8b75-af05111dc2c4",
  "created_at": "string",
  "render_ended_at": "string",
  "status": "pending"
}

Responses

Status Meaning Description Schema
200 OK Rendering status Output

Schemas

Input

{
  "format": "audio",
  "callback": "https://example.com/callback_url",
  "items": [
    {
      "type": "text",
      "text": "The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz prog. Junk MTV quiz graced by fox whelps.",
      "audio": "https://example.com/audiofile.mp3",
      "image": "https://example.com/cute_kittens.jpg",
      "title": "string",
      "voice_id": "fr_fr_female_1"
    }
  ]
}

Properties

Name Type Required Restrictions Description
format string true none Desired output format, audio is mp3, video is mp4
callback string(uri) false none Webhook callback URL to be called at the end of the rendering process.
See webhooks for details
items [InputItem] true none none

Enumerated Values

Property Value
format audio
format video
format video-mobile

InputItem

{
  "type": "text",
  "text": "The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz prog. Junk MTV quiz graced by fox whelps.",
  "audio": "https://example.com/audiofile.mp3",
  "image": "https://example.com/cute_kittens.jpg",
  "title": "string",
  "voice_id": "fr_fr_female_1"
}

Properties

Name Type Required Restrictions Description
type string true none Item type
text string(ssml) false none Text content, required if the item is of text type.
Accepts SSML tags
audio string(uri) false none Audio file URL, required if the item is of audio type.
Accepts MP3 format.
image string(uri) false none Image URL that will be displayed for this item in the video output.
title string false none Text that will be displayed over the item's image in the video output.
voice_id string false none Voice identifier that will be used, required if the item is of text type.
See voices for more details

Enumerated Values

Property Value
type text
type audio

Output

{
  "id": "db00fa34-b6b0-4b6b-8b75-af05111dc2c4",
  "created_at": "string",
  "render_ended_at": "string",
  "status": "pending"
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none none
created_at string(datetime) false none none
render_ended_at string(datetime) false none none
status string false none none

Enumerated Values

Property Value
status pending
status rendering
status failed
Curl Javascript