Create BYOK credential

Add a new bring-your-own-key (BYOK) provider credential.

Inputs

POSThttps://api.zoice.com/v1/byok
body
string
required
Add a name for the credential to be added. For eg., ElevenLabs Personal
body
string
required
Select the provider of the API key.
body
string
required
Paste the API key you have created from the provider platform.
idle

Introduction

Bring Your Own Keys (BYOK) is a feature on Zoice that lets you securely store third-party API credentials through the API endpoint or the dashboard. The credential_id, which is generated by the system after successfully adding a BYOK key, can be used to import voices from the selected provider.

When using an imported voice to generate an avatar video, your BYOK API key handles the audio generation directly, so you are only charged for the video rendering on Zoice API platform.

Using the Endpoint

Create a new BYOK credential record by sending a POST request to /v1/byok helper endpoint with the body of the request containing the following parameters:

POSThttps://api.zoice.com/v1/byok
  • key_name: The name of the key to be added. For eg., ElevenLabs Personal Account.
  • provider: The provider of the API key. For eg., elevenlabs.
  • api_key: The raw API key generated on the provider platform.

Please visit API documentation to learn more about the parameters, request and output format, and schema info, please visit the detailed API docs of the Create BYOK Credential endpoint.