Skip to content
/Organizations

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

Get organization list

Request

Retrieve array of all organizations the user has access to.

Returns metadata for each organization including:

  • Organization ID and name
  • Workspaces within each organization
  • Branding configuration (colors, logos, company info)
  • Video prompts and ideas
  • User access status and user count
Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/list \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved organization list.

Bodyapplication/jsonArray [
idstring

Unique organization identifier

Example: "693fb82afd8d1c43077ba0fb"
namestring

Organization name

Example: "My Organization"
workspacesArray of objects

List of workspaces in this organization

brandingobject(UserBranding)

User's branding configuration for video creation

createdByEmailstring(email)

Email of organization creator

isAllowedToUseOrganizationboolean

Whether user can use this organization

userCountinteger

Number of users in organization

isDefaultForUserboolean

Whether this is the user's default organization

]
Response
application/json
[
  {
    "id": "693fb82afd8d1c43077ba0fb",
    "name": "My Organization",
    "workspaces": [ … ],
    "branding": { … },
    "createdByEmail": "info@shuffll.com",
    "isAllowedToUseOrganization": true,
    "userCount": 1,
    "isDefaultForUser": true
  }
]

Get specific organization

Request

Retrieve detailed information about a specific organization including:

  • Organization ID and name
  • All workspaces with detailed metrics (asset count, project count, template count)
  • Complete branding configuration
  • User information
Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

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

Responses

Successfully retrieved organization details.

Bodyapplication/json
idstring

Unique organization identifier

Example: "693fb82afd8d1c43077ba0fb"
namestring

Organization name

Example: "My Organization"
workspacesArray of objects(WorkspaceDetail)

List of workspaces with detailed metrics

brandingobject(UserBranding)

User's branding configuration for video creation

createdByEmailstring(email)

Email of organization creator

userCountinteger

Number of users in organization

Response
application/json
{
  "id": "693fb82afd8d1c43077ba0fb",
  "name": "My Organization",
  "workspaces": [
    { … }
  ],
  "branding": {
    "isDefault": true,
    "enabled": true,
    "company": { … },
    "logo": "/files/platform/onboarding/logo-placeholder.svg",
    "logoW": "/files/platform/onboarding/logo-placeholder.svg",
    "colors": { … },
    "pronunciations": []
  },
  "createdByEmail": "info@shuffll.com",
  "userCount": 1
}

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