Skip to content
/Templates

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

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

Get all templates

Request

Retrieve a list of all templates you have created in your account.

Templates are reusable video project structures that define scene order, types, and configurations.

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

Responses

Successfully retrieved templates.

Bodyapplication/jsonArray [
idstring

Unique template identifier

Example: "6945258969368fe55125c4b9"
descriptionstring

Template description

Example: "A template for new product demo videos"
namestring

Template name

Example: "Product Demo Template"
]
Response
application/json
[
  {
    "id": "6945258969368fe55125c4b9",
    "description": "This is a sample template about how useful trees are",
    "name": "Trees for Kids - Template"
  }
]

Get templates by organization and workspace

Request

Retrieve all templates for a specific organization and workspace.

This endpoint allows you to get templates from a particular organization and workspace rather than the default ones.

Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example: 693fb82afd8d1c43077ba0fb
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/693fb82afd8d1c43077ba0fe/templates \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved templates.

Bodyapplication/jsonArray [
idstring

Unique template identifier

Example: "6945258969368fe55125c4b9"
descriptionstring

Template description

Example: "A template for new product demo videos"
namestring

Template name

Example: "Product Demo Template"
]
Response
application/json
[
  {
    "id": "6945258969368fe55125c4b9",
    "description": "This is a sample template about how useful trees are",
    "name": "Trees for Kids - Template"
  }
]

Get specific template

Request

Retrieve detailed information about a specific template including:

  • Template ID, name, and description
  • All scenes with their types and order
  • Dynamic fields for each scene (headers, colors, texts, voice settings, etc.)
  • Scene configuration options

Use this endpoint to understand the template structure before creating a project from it.

Security
ShuffllApiKey
Path
templateIdstringrequired

Unique identifier for the template

Example: 67682e831de738f85b0d0fc9
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/templates/67682e831de738f85b0d0fc9 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved template details.

Note: For the project creation process, you can provide initial values for scenes using the dynamic values through the API.

Bodyapplication/json
idstring

Unique template identifier

Example: "6945258969368fe55125c4b9"
descriptionstring

Template description

Example: "This is a sample template about how useful trees are"
namestring

Template name

Example: "Trees for Kids - Template"
scenesArray of objects(TemplateScene)

Array of scenes in the template

Response
application/json
{
  "id": "6945258969368fe55125c4b9",
  "description": "This is a sample template about how useful trees are",
  "name": "Trees for Kids - Template",
  "scenes": [
    { … },
    { … },
    { … }
  ]
}

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