API Reference

🗣 Voices to create realistic, human-like speech.

The Audio endpoint provides users access to high-quality audio files, including soundtracks and voices.

Voices in YEPIC AI comes with various accents, languages, and gender - making them more unique and customisable. This technology has numerous applications, including virtual assistants, speech-to-text transcription, and text-to-speech conversion.

⚙️ How It Works

☎️ API Calls - Examples

📘

Info

See the list of soundtracks and available voices.

1. POST - Text to speech

Text-to-speech endpoint allows you to convert text into spoken words. It reads the text using speech synthesis and AI voices that sound natural.

curl --request POST \
     --url https://api.yepic.ai/v1/speech \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '
{
  "weightMusic": 1,
  "voiceId": "voice_id",
  "script": "Hello, this is Speech endpoint from Yepic AI",
  "soundTemplate": "copacabana"
}
'
{}

2. GET - Retrieve a list of sounds

This endpoint will retrieve a list of sounds along with their details.

curl --request GET \
     --url https://api.yepic.ai/v1/sounds \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'
{
  "sounds": [
    {
      "isElastic": true,
      "collections": [
        "ready set audio ads"
      ],
      "sample": "https://file.api.audio/template-samples/3am_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "3am",
      "description": "Starts off soft and then builds up to a chilled, jazzy vibe that eminates relaxation.",
      "tempo": "mid",
      "tags": [
        "minimal",
        "relaxed"
      ],
      "soundTemplateId": "3am"
    },
    {
      "isElastic": true,
      "collections": [],
      "sample": "https://file.api.audio/template-samples/acousticstrings_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "",
      "templateName": "acousticstrings",
      "description": "A template for testing elastic audio",
      "tempo": "",
      "tags": [],
      "soundTemplateId": "acousticstrings"
    },
    {
      "isElastic": true,
      "collections": [
        "newscast"
      ],
      "sample": "https://file.api.audio/template-samples/articles_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "articles",
      "description": "A calm and focused news template which would compliment creative stories. ",
      "tempo": "mid",
      "tags": [
        "focus",
        "relaxed"
      ],
      "soundTemplateId": "articles"
    },
    {
      "isElastic": false,
      "collections": [
        "commercial"
      ],
      "sample": "",
      "contents": [
        "intro",
        "outro",
        "main"
      ],
      "genre": "electronic",
      "templateName": "bluewater",
      "description": "bluewater",
      "tempo": "mid",
      "tags": [
        "positive"
      ],
      "soundTemplateId": "bluewater"
    },
    {
      "isElastic": false,
      "collections": [
        "newscast"
      ],
      "sample": "https://file.api.audio/template-samples/breakingnews_sample.mp3",
      "contents": [
        "effect1",
        "effect4",
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "breakingnews",
      "description": "The familiar interlude for the breaking news: looming, intense with a cliffhanger feeling. ",
      "tempo": "mid",
      "tags": [
        "intense",
        "minimal",
        "reflective"
      ],
      "soundTemplateId": "breakingnews"
    },
    {
      "isElastic": false,
      "collections": [
        "ready set audio ads"
      ],
      "sample": "https://file.api.audio/template-samples/workitout_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "workitout",
      "description": "",
      "tempo": "up",
      "tags": [
        "intense",
        "uplifting",
        "workout"
      ],
      "soundTemplateId": "workitout"
    },
    {
      "isElastic": false,
      "collections": [
        "commercial",
        "kids entertainment"
      ],
      "sample": "https://file.api.audio/template-samples/hautecuisine_sample.mp3",
      "contents": [
        "effect1",
        "effect2",
        "effect3",
        "intro",
        "main",
        "outro"
      ],
      "genre": "acoustic",
      "templateName": "hautecuisine",
      "description": "Eat, drink, and be merry:this is exactly the feeling you get from this melodic, all round happy tune.",
      "tempo": "mid",
      "tags": [
        "melodic",
        "happy",
        "minimal"
      ],
      "soundTemplateId": "hautecuisine"
    },
    {
      "isElastic": true,
      "collections": [
        "ready set audio ads"
      ],
      "sample": "https://file.api.audio/template-samples/havana_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "havana",
      "description": "Instantly transport your listeners to a tropical island with this up-tempo relaxing track.",
      "tempo": "mid",
      "tags": [
        "happy",
        "relaxed"
      ],
      "soundTemplateId": "havana"
    },
    {
      "isElastic": false,
      "collections": [
        "newscast"
      ],
      "sample": "https://file.api.audio/template-samples/headlines_sample.mp3",
      "contents": [
        "effect1",
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "headlines",
      "description": "What make the news headlines today? Find out with this intense and informative template.",
      "tempo": "mid",
      "tags": [
        "intense",
        "informative",
        "minimal"
      ],
      "soundTemplateId": "headlines"
    },
    {
      "isElastic": true,
      "collections": [
        "newscast"
      ],
      "sample": "https://file.api.audio/template-samples/heartfelt_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "acoustic",
      "templateName": "heartfelt",
      "description": "Serious and sincere, this track is ideal for deep news stories that touch hearts.",
      "tempo": "down",
      "tags": [
        "focus",
        "ambience"
      ],
      "soundTemplateId": "heartfelt"
    },
    {
      "isElastic": false,
      "collections": [
        "commercial",
        "fitness"
      ],
      "sample": "https://file.api.audio/template-samples/heatwave_sample.mp3",
      "contents": [
        "effect1",
        "effect2",
        "effect3",
        "intro",
        "main",
        "outro"
      ],
      "genre": "electronic",
      "templateName": "heatwave",
      "description": "Uptempo soulful house, made to make you move and sweat.",
      "tempo": "up",
      "tags": [
        "uplifting",
        "energetic",
        "happy"
      ],
      "soundTemplateId": "heatwave"
    },
    {
      "isElastic": false,
      "collections": [
        "commercial",
        "ready set audio ads"
      ],
      "sample": "https://file.api.audio/template-samples/hotwheels_sample.mp3",
      "contents": [
        "effect1",
        "effect2",
        "effect3",
        "intro",
        "main",
        "outro"
      ],
      "genre": "rock",
      "templateName": "hotwheels",
      "description": "A hard guitar riff with an action theme, guaranteed to pump you up with excitement!",
      "tempo": "up",
      "tags": [
        "intense",
        "energetic",
        "uplifting"
      ],
      "soundTemplateId": "hotwheels"
    },
    {
      "isElastic": true,
      "collections": [
        "newscast"
      ],
      "sample": "https://file.api.audio/template-samples/worldleaders_sample.mp3",
      "contents": [
        "intro",
        "main",
        "outro"
      ],
      "genre": "acoustic",
      "templateName": "worldleaders",
      "description": "This melodic track is dramatic enough to enhance any news story. ",
      "tempo": "up",
      "tags": [
        "acoustic",
        "uplifting"
      ],
      "soundTemplateId": "worldleaders"
    }
  ]
}

3. GET - Retrieve a sound

This endpoint will get you a specific sound by its id.

curl --request GET \
     --url https://api.yepic.ai/v1/sounds/SOUND_ID \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'
{
  "sound": {
    "isElastic": true,
    "collections": [
      "string"
    ],
    "sample": "string",
    "contents": [
      "string"
    ],
    "genre": "string",
    "templateName": "string",
    "description": "string",
    "tempo": "string",
    "tags": [
      "string"
    ],
    "soundTemplateId": "string"
  }
}

4. GET - Retrieve a list of voices

This endpoint allows you to get a list of existing voices.

curl --request GET \
     --url 'https://api.yepic.ai/v1/voices?query=' \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'
{
  "voices": [
    {
      "languageCodes": [
        "German (Germany)"
      ],
      "name": "stefan",
      "gender": "male",
      "voiceId": "go-de-DE-stefan",
      "providerVoiceId": "de-DE-Wavenet-E",
      "language": "German (Germany)",
      "languageCode": "de-DE",
      "languageCodesJson": "[\"German (Germany)\"]",
      "provider": "Google",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "0176f8a4-f167-4e6a-bebf-b0b5b7b7e740"
    },
    {
      "languageCodes": [
        "French (France)"
      ],
      "name": "pauline",
      "gender": "female",
      "voiceId": "go-fr-FR-pauline",
      "providerVoiceId": "fr-FR-Wavenet-A",
      "language": "French (France)",
      "languageCode": "fr-FR",
      "languageCodesJson": "[\"French (France)\"]",
      "provider": "Google",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "0f382051-7167-4d07-b3fa-b525f0fc619d"
    },
    {
      "languageCodes": [
        "Dutch (Netherlands)"
      ],
      "name": "lotte",
      "gender": "female",
      "voiceId": "ib-nl-NL-lotte",
      "providerVoiceId": "nl-NL_EmmaVoice",
      "language": "Dutch (Netherlands)",
      "languageCode": "nl-NL",
      "languageCodesJson": "[\"Dutch (Netherlands)\"]",
      "provider": "Ibm",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "0554ebc0-ca46-4134-9240-4eada153168d"
    },
    {
      "languageCodes": [
        "Korean (South Korea)"
      ],
      "name": "yuna",
      "gender": "female",
      "voiceId": "ib-ko-KR-yuna",
      "providerVoiceId": "ko-KR_YunaVoice",
      "language": "Korean (South Korea)",
      "languageCode": "ko-KR",
      "languageCodesJson": "[\"Korean (South Korea)\"]",
      "provider": "Ibm",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "06111063-fc77-4b01-a055-23418714385c"
    },
    {
      "languageCodes": [
        "English (Australia)"
      ],
      "name": "steve",
      "gender": "male",
      "voiceId": "ib-en-AU-steve",
      "providerVoiceId": "en-AU_SteveVoice",
      "language": "English (Australia)",
      "languageCode": "en-AU",
      "languageCodesJson": "[\"English (Australia)\"]",
      "provider": "Ibm",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "0650735a-409e-4e69-9c8f-9ff9633e5c22"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "ava",
      "gender": "female",
      "voiceId": "ib-en-US-ava",
      "providerVoiceId": "en-US_EmilyV3Voice",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Ibm",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "0c6afe43-14bf-458a-a132-d3e3bca9e292"
    },
    {
      "languageCodes": [
        "Spanish (Latin America)"
      ],
      "name": "eliana",
      "gender": "female",
      "voiceId": "ib-es-LA-eliana",
      "providerVoiceId": "es-LA_SofiaVoice",
      "language": "Spanish (Latin America)",
      "languageCode": "es-LA",
      "languageCodesJson": "[\"Spanish (Latin America)\"]",
      "provider": "Ibm",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "20e231ab-1e9e-4c19-9bf6-62274d41ef0c"
    },
    {
      "languageCodes": [
        "English (United Kingdom)"
      ],
      "name": "beth",
      "gender": "female",
      "voiceId": "po-en-GB-beth",
      "providerVoiceId": "Amy",
      "language": "English (United Kingdom)",
      "languageCode": "en-GB",
      "languageCodesJson": "[\"English (United Kingdom)\"]",
      "provider": "Amazon",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "1c73675b-b2c4-4ac5-8b4c-bee76ceea52c"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "colin",
      "gender": "male",
      "voiceId": "po-en-US-colin",
      "providerVoiceId": "Joey",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Amazon",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "1dc53e1f-f294-401f-a40d-f5ffbd05398f"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "deanna",
      "gender": "female",
      "voiceId": "re-en-US-deanna",
      "providerVoiceId": "9611ff3e",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Resemble",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "f7d51e94-acb8-46ee-9931-59f7de1e2679"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "graham",
      "gender": "male",
      "voiceId": "re-en-US-graham",
      "providerVoiceId": "1f33ce74",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Resemble",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "550a911a-40b2-4d9f-8000-a3afb7538bec"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "corey",
      "gender": "male",
      "voiceId": "po-en-US-corey",
      "providerVoiceId": "Kevin",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Amazon",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "573b58d1-50ab-4fbc-91a3-a6f03bbecb73"
    },
    {
      "languageCodes": [
        "Spanish (Spain)"
      ],
      "name": "joaquin",
      "gender": "male",
      "voiceId": "po-es-ES-joaquin",
      "providerVoiceId": "Enrique",
      "language": "Spanish (Spain)",
      "languageCode": "es-ES",
      "languageCodesJson": "[\"Spanish (Spain)\"]",
      "provider": "Amazon",
      "isNeural": false,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "5e8248e2-e173-4fef-ab1f-b70a36fdc186"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "linda",
      "gender": "female",
      "voiceId": "po-en-US-linda",
      "providerVoiceId": "Joanna",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Amazon",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "5f778170-be6e-4dca-a382-32ae743d874b"
    },
    {
      "languageCodes": [
        "English (United States)"
      ],
      "name": "gene",
      "gender": "male",
      "voiceId": "re-en-US-gene",
      "providerVoiceId": "366ae1d8",
      "language": "English (United States)",
      "languageCode": "en-US",
      "languageCodesJson": "[\"English (United States)\"]",
      "provider": "Resemble",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "63d77620-b55a-4cf1-9df4-8814b1a9577c"
    },
    {
      "languageCodes": [
        "Irish (Ireland)"
      ],
      "name": "orla",
      "gender": "female",
      "voiceId": "az-ga-IE-orla",
      "providerVoiceId": "ga-IE-OrlaNeural",
      "language": "Irish (Ireland)",
      "languageCode": "ga-IE",
      "languageCodesJson": "[\"Irish (Ireland)\"]",
      "provider": "Azure",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "4df29637-91a9-4a94-b83f-aa92b6b49da0"
    },{
      "languageCodes": [
        "Turkish (Turkey)"
      ],
      "name": "emel",
      "gender": "female",
      "voiceId": "az-tr-TR-emel",
      "providerVoiceId": "tr-TR-EmelNeural",
      "language": "Turkish (Turkey)",
      "languageCode": "tr-TR",
      "languageCodesJson": "[\"Turkish (Turkey)\"]",
      "provider": "Azure",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "fce72ff1-4e24-4afe-8f3c-671a4fb25127"
    },
    {
      "languageCodes": [
        "Ukrainian (Ukraine)"
      ],
      "name": "polina",
      "gender": "female",
      "voiceId": "az-uk-UA-polina",
      "providerVoiceId": "uk-UA-PolinaNeural",
      "language": "Ukrainian (Ukraine)",
      "languageCode": "uk-UA",
      "languageCodesJson": "[\"Ukrainian (Ukraine)\"]",
      "provider": "Azure",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "fedaecb6-7297-487f-8ee8-96099e97cde0"
    },
    {
      "languageCodes": [
        "Czech (Czechia)"
      ],
      "name": "vlasta",
      "gender": "female",
      "voiceId": "az-cs-CZ-vlasta",
      "providerVoiceId": "cs-CZ-VlastaNeural",
      "language": "Czech (Czechia)",
      "languageCode": "cs-CZ",
      "languageCodesJson": "[\"Czech (Czechia)\"]",
      "provider": "Azure",
      "isNeural": true,
      "textToSpeechApiProvider": "Yepic",
      "audioSampleUrl": null,
      "id": "ff81a66c-9d37-47f6-b00e-976dd6529c7a"
    }
  ]
}

5. GET - Retrieve a voice

This endpoint allows you to get a specific voice using its id.

curl --request GET \
     --url https://api.yepic.ai/v1/voices/VOICE_ID \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'
{
  "voice": {
    "languageCodes": [
      "Arabic (Algeria)"
    ],
    "name": "ismael",
    "gender": "male",
    "voiceId": "az-ar-DZ-ismael",
    "providerVoiceId": "ar-DZ-IsmaelNeural",
    "language": "Arabic (Algeria)",
    "languageCode": "ar-DZ",
    "languageCodesJson": "[\"Arabic (Algeria)\"]",
    "provider": "Azure",
    "isNeural": true,
    "textToSpeechApiProvider": "Yepic",
    "audioSampleUrl": null,
    "id": "6885fc0e-1991-445e-a7b9-95c9cd3803ad"
  }
}

📌 Need help?

If you require assistance or encounter any issues, we recommend referring to our FAQ page first. If you are still unable to resolve your issue, please don't hesitate to contact us for further support.