Request Body

Parameter	Description
actorId	Type: `string` The unique identifier for your digital actor (eg., `7528735effb7cde8cd5474dc110905c2`).
voiceId	Type: `string` The unique identifier for the voice to be paired with your digital actor (eg., `b2c11ebef1e47591f75bceef56635435`). Only the `voiceId` OR `language` parameter can be sent per request.
language	Type: `string` The unique language code to be applied to the selected avatar (eg., `en-US` or `es-MX`). Providing a language code will select the default voice associated with that particular language/country. A list of supported language codes can be found here. Only the `voiceId` OR `language` parameter can be sent per request.
script	Type: `string` Text script to generate a text-to-video performance from your digital actor. Pipio supports text from over 80 different languages. Text scripts are limited to 5,000 characters per clip.
fps	Type: `int` The frame rate of the video (`30` or `60`) Default: `60`
transparent	Type: `boolean` Describes whether the final video has a transparent background. Default: `false`
callbackUrl	Type: `string` This parameter represents the location the server will send the response to.

Response

Parameter	Description
id	Type:`string` The unique identifier for the video asset.
accountId	Type: `string` The unique identifier associated with your Pipio account.
status	Type: `string` The status of the video render: - `Pending` (The video is currently rendering) - `Completed` (The video render was successful) - `Failure` (An error occurred when rendering video).
creditCost	Type: `int` The number of video credits debited from your account.
estimatedCompleteDate	Type: `string` Estimated date/time to completion for the video render.
createdDate	Type: `string` Timestamp of when the video finished rendering.