Voice Profile
Voice Profiles allows you to define unique AI-generated brand voices that you can apply to your content. By using the API requests, you can create, view, update, and delete the Voice Profile in a Brand Kit.
Get All Voice Profiles
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}/voice-profiles?skip={index}&limit={limit}&include_users={boolean}&include_count={boolean}&typeahead={string}&sort={string}&order={string}The Get All Voice Profiles request fetches the list of all Voice Profiles in a Brand Kit within an organization.
To configure the permissions for your application via OAuth, include the brand-kits:read scope.
{
"voice_profile": {
"brand_kit_uid": "cs***************0",
"uid": "cs***************d",
"name": "Test Voice Profile",
"description": "This is the sample description for new Voice Profile.",
"communication_style": {
"formality_level": 4,
"tone": 3,
"humor_level": 2,
"complexity_level": 1
},
"created_at": "2024-05-13T15:59:02.987Z",
"created_by": "bl***************b",
"updated_at": "2024-05-13T15:59:02.987Z",
"updated_by": "bl***************b",
"deleted_at": false
}
}Get a Single Voice Profile
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}/voice-profiles/{voice_profile_uid}?include_users={boolean}The Get a Single Voice Profile request fetches the specific Voice Profile from a Brand Kit in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:read scope.
{
"voice_profile": {
"brand_kit_uid": "cs***************0",
"uid": "cs***************d",
"name": "Test Voice Profile",
"description": "This is the sample description for new Voice Profile.",
"communication_style": {
"formality_level": 4,
"tone": 3,
"humor_level": 2,
"complexity_level": 1
},
"created_at": "2024-05-13T15:59:02.987Z",
"created_by": "bl***************b",
"updated_at": "2024-05-13T15:59:02.987Z",
"updated_by": "bl***************b",
"deleted_at": false
}
}Create Voice Profile
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}/voice-profilesThe Create Voice Profile request lets you create a new Voice Profile in a Brand Kit within an organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
Here’s an example of the Request Body for creating a new Voice Profile:
{
"voice_profile": {
"name": "Sample Voice Profile",
"description": "This is the sample description for new Voice Profile.",
"communication_style": {
"formality_level": 4,
"tone": 3,
"humor_level": 2,
"complexity_level": 1
}
}
}{
"voice_profile": {
"name": "Sample Voice Profile",
"description": "This is the sample description for new Voice Profile.",
"communication_style": {
"formality_level": 4,
"tone": 3,
"humor_level": 2,
"complexity_level": 1
}
}
}{
"message": "Voice Profile created successfully",
"voice_profile": {
"brand_kit_uid": "cs*************4d",
"uid": "cs*************49",
"name": "Sample Voice Profile",
"description": "This is the sample description for new Voice Profile.",
"communication_style": {
"formality_level": 4,
"tone": 3,
"humor_level": 2,
"complexity_level": 1
},
"created_at": "2024-06-06T12:18:18.619Z",
"created_by": "bl*************5b",
"updated_at": "2024-06-06T12:18:18.619Z",
"updated_by": "bl*************5b",
"deleted_at": false
}
}Update Voice Profile
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}/voice-profiles/{voice_profile_uid}The Update Voice Profile request lets you update an existing Voice Profile from the Brand Kit in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
Here’s an example of the Request Body for updating a Voice Profile:
{
"voice_profile":{
"description": "Test Brand Kit Description",
"insights": "Sample Insights",
"sample_content": "Sample Content",
"communication_style": {
"complexity_level": 1,
"formality_level": 2,
"humor_level": 3,
"tone": 4
}
}
}{
"voice_profile":{
"description": "Test Brand Kit Description",
"insights": "Sample Insights",
"sample_content": "Sample Content",
"communication_style": {
"complexity_level": 1,
"formality_level": 2,
"humor_level": 3,
"tone": 4
}
}
}{
"message": "Voice Profile updated successfully",
"voice_profile": {
"brand_kit_uid": "cs***************0",
"uid": "cs*************d",
"name": "Test Voice Profile",
"description": "Test Brand Kit Description",
"communication_style": {
"complexity_level": 1,
"formality_level": 2,
"humor_level": 3,
"tone": 4
},
"created_at": "2024-05-13T15:59:02.987Z",
"created_by": "bl*************b",
"updated_at": "2024-05-13T16:25:55.803Z",
"updated_by": "bl*************b",
"deleted_at": false,
"description": "Test Brand Kit Description",
"insights": "Sample Insights",
"sample_content": "Sample Content"
}
}Delete Voice Profile
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}/voice-profiles/{voice_profile_uid}The Delete Voice Profile request lets you delete an existing Voice Profile from the Brand Kits in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
{
"message": "Voice Profile deleted successfully"
}