introduction

unlock the power of personalized audio with sync.’s /voices endpoint. this tool enables you to create custom voice clones, allowing for the ultimate customization of your projects. whether you’re aiming to match a specific vocal style or infuse your brand’s unique character into your content, our technology ensures your videos stand out.

craft voice clones with ease and integrate them with our animate and speak endpoints for a cohesive and engaging audio experience. ideal for content creators, marketers, and educators looking to elevate their audiovisual projects.

api features

custom voice creation

easily create custom voice clones tailored to your project’s needs.

seamless integration

integrate your custom voices with our animate and speak endpoints for a unified project workflow.

enhanced engagement

engage your audience with unique voiceovers that elevate your content.

quick start

authentication

before you can start using our api, you need to authenticate your requests. this is done using an x-api-key that links your requests to your account. if you don’t have an api key yet, check out the instructions here to obtain one.

create your custom voice

with your x-api-key ready, you can begin creating custom voice clones. to use the /voices via the playground above follow the instructions below:

authorize

enter your api key in the x-api-key field within the Authorization section.

enter your x-api-key in the authorization section

enter params

enter the params in the body section:

enter the urls for your publicly accessible audio and video files into the respective fields and set other required parameters.

example input

{
  "name": "Example voice name",
  "description": "This is a description for the example voice.",
  "inputSamples": ["https://example.com/sample1.mp3"],
}

this example request outlines the basic structure for creating a voice clone.

submit

click the Send button to submit your request. after submission, you will receive a response that includes the id of your voice, the current status, and the details of the submission.

understanding the response

the initial response provides you with essential details to track your job:

{
  "id": "unique_job_id",
  "createdAt": "date_time",
  "status": "processing",
  "name": "Example voice name",
  "description": "This is a description for the example voice.",
  "inputSamples": ["https://example.com/sample1.mp3"],
  "creditsDeducted": 123,
  "webhookUrl": null,
  "errorMessage": null
}

your job’s status will start as pending and move to processing. use the returned id with the GET /voices/{id} endpoint to periodically poll for the status of your job. this polling is crucial for knowing when your video is ready.

polling for completion

periodically send requests to GET /voices/{id} with your job id. when the job status changes to completed, the response will include a URL to download your synced video.

Click here to view instructions on polling for job completion with the get voice api playground

embrace the power of custom voices to bring a new level of personalization to your projects. with sync., your content can truly speak in your brand’s voice.

Authorizations

x-api-key

string

headerrequired

Body

application/json

inputSamples

string[]

required

A list of audio samples to use for voice generation

name

string

The name of the voice. Helpful for organization and search purposes.

description

string

The description of the voice. Helpful for keeping track of voice details.

maxCredits

number

Maximum number of credits to use for audio generation. If job exceeds this value, the job will be aborted

webhookUrl

string

A url to send a notification to upon completion of audio generation

Response

201 - application/json

string

required

A unique identifier for the voice.

createdAt

string

required

The date and time the voice was created.

status

string

required

The status of the voice.

inputSamples

string[]

required

Input samples for creating the voice.

outputSamples

string[]

required

Output samples for hearing the voice.

creditsDeducted

number

required

The cost of the voice.

webhookUrl

string

required

The webhook URL for the voice.

errorMessage

string

required

An error message if the voice failed to process.

name

string

A name for the voice.

description

string

A description the voice.

api documentation

lipsync

animate

speak

voices

Post voice

introduction

api features

custom voice creation

seamless integration

enhanced engagement

quick start

authentication

create your custom voice

example input

understanding the response

polling for completion

Authorizations

Body

Response

api documentation

lipsync

animate

speak

voices

​introduction

​api features

custom voice creation

seamless integration

enhanced engagement

​quick start

​authentication

​create your custom voice

example input

understanding the response

polling for completion

Authorizations

Body

Response

introduction

api features

quick start

authentication

create your custom voice