Skip to content
API Reference/
/
Get AI voice options

Shuffll API (1.2.0)

The Shuffll API enables seamless automation and integration of Shuffll's AI-powered video creation platform into external workflows.

What is Shuffll?

Shuffll is an AI-powered platform designed to automate and streamline video content creation for businesses, marketers, and content creators. By leveraging machine learning, Shuffll enables users to generate high-quality videos efficiently, reducing production time and effort while maintaining creative control.

With Shuffll's API, developers can integrate automated video generation into their applications, enabling seamless video content production at scale. Whether it's for marketing, social media, training, or corporate communications, Shuffll simplifies the process of creating engaging and professional videos.

Key Features

  • AI-Driven Video Creation – Generate videos automatically based on structured input, scripts, or templates.
  • Smart Editing & Automation – Apply transitions, overlays, and effects without manual editing.
  • Custom API Endpoints – Programmatically generate, edit, and manage video content.
  • Brand Consistency – Ensure that videos align with predefined brand styles and messaging.
  • Seamless Integrations – Connect with third-party tools, media libraries, and content management systems.

Shuffll's API empowers developers to automate video production, integrate AI-enhanced video workflows, and create personalized video content at scale—all with minimal effort.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://shuffll.com
E-mail
info@shuffll.com
License
MIT
Terms of Service
Languages
Servers
Mock server
https://api-docs.shuffll.com/_mock/apis
https://api.shuffll.com/api/v1

Configuration

Retrieve available options for AI voices, avatars, background music, and video category tags. Call these endpoints to populate field values when creating a project.

Operations

Get storytelling techniques

Request

Retrieve all available storytelling techniques for video creation. Returns an array of 12 storytelling techniques with descriptions, explanations of why they work, and examples.

Use these techniques when creating projects to structure your video narrative effectively.

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/storytelling_techniques \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved storytelling techniques.

Bodyapplication/json
techniquesArray of objects(StorytellingTechnique)

List of storytelling techniques

Response
application/json
{
  "techniques": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Get tone of voice options

Request

Retrieve all available tone of voice options for video narration. Returns an array of tone options with descriptions.

Use the id value as toneOfVoice when creating a project.

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/tone_of_voice \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved tone of voice options.

Bodyapplication/json
tonesArray of objects(ToneOfVoice)

List of tone options

Response
application/json
{
  "tones": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Get video category tags

Request

Retrieve all available video category tags.

Use the id value as videoTagId when creating a project to categorize your video (e.g., Marketing, Explainer, Training).

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/video_tags \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved video tags.

Bodyapplication/json
tagsArray of objects(VideoTag)
Response
application/json
{
  "tags": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Get AI voice options

Request

Retrieve all available AI voice-over options and tone styles.

Returns two arrays:

  • aiVoiceOptions — the list of available voices. Use the id value as aiVoiceSettings.voiceId when creating a project.
  • aiVoiceTones — tone styles that can be layered on top of a voice (e.g., friendly, professional, dramatic).

Voices are provided by either OpenAI or ElevenLabs depending on the voiceType field.

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/ai_voice_options \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved AI voice options.

Bodyapplication/json
aiVoiceOptionsArray of objects(AiVoiceOption)

List of available voice-over options

aiVoiceTonesArray of objects(AiVoiceTone)

List of tone styles that can be applied to a voice

Response
application/json
{
  "aiVoiceOptions": [
    { … },
    { … },
    { … }
  ],
  "aiVoiceTones": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Get AI avatar options

Request

Retrieve all available AI avatar presenter options.

Each avatar has a name, accent, and a preview video URL. Use the id value when configuring an AI avatar presenter for your project.

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/ai_avatar_options \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved AI avatar options.

Bodyapplication/json
aiAvatarOptionsArray of objects(AiAvatarOption)
Response
application/json
{
  "aiAvatarOptions": [
    { … },
    { … }
  ]
}

Get background music library

Request

Retrieve all available background music tracks.

Use the relativePath value as customTemplate.preConfigs.bgMusic.path when creating a project to set the background music.

Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/music-library \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved music library.

Bodyapplication/jsonArray [
idstring

Track identifier

Example: "track_upbeat_001"
namestring

Track name

Example: "Upbeat Corporate"
relativePathstring

Path to use as customTemplate.preConfigs.bgMusic.path when creating a project

Example: "/music/upbeat-corporate.mp3"
imagestring

Track artwork URL

Example: "https://content.shuffll.com/music/upbeat-corporate-cover.jpg"
]
Response
application/json
[
  {
    "id": "track_upbeat_001",
    "name": "Upbeat Corporate",
    "relativePath": "/music/upbeat-corporate.mp3",
    "image": "https://content.shuffll.com/music/upbeat-corporate-cover.jpg"
  },
  {
    "id": "track_ambient_002",
    "name": "Ambient Focus",
    "relativePath": "/music/ambient-focus.mp3",
    "image": "https://content.shuffll.com/music/ambient-focus-cover.jpg"
  },
  {
    "id": "track_cinematic_003",
    "name": "Cinematic Inspire",
    "relativePath": "/music/cinematic-inspire.mp3",
    "image": "https://content.shuffll.com/music/cinematic-inspire-cover.jpg"
  }
]

Organizations

Manage organizations and retrieve their workspaces, branding, and settings.

Operations

Workspaces

Manage workspaces within an organization, and list projects within a workspace.

Operations

Branding

Read and update branding configuration (logo, colors, company info, pronunciations) for a workspace or organization.

Operations

Assets

Upload, organize, rename, move, and delete media assets in a workspace. Assets can be referenced directly in project creation requests.

Operations

Templates

Browse and retrieve reusable video templates. Templates define the scene structure and visual style of a project.

Operations

Projects

Create, monitor, and manage AI-generated video projects.

Operations

Enhance

Monitor the automatic post-production enhancement process (branding, subtitles, audio cleanup) that runs after a project is created.

Operations

Export

Trigger video export and retrieve the final downloadable video URLs.

Operations