Skip to content
API Reference/
/
Update workspace

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

Get workspace

Request

Retrieve detailed information about a specific workspace including:

  • Workspace ID and name
  • Metrics (asset count, project count, template count, user count)
  • Complete branding configuration
  • Video prompts and ideas
  • Creator information
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 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved workspace details.

Bodyapplication/json
idstring

Workspace identifier

Example: "693fb82afd8d1c43077ba0fe"
namestring

Workspace name

Example: "My Workspace"
assetCountinteger

Number of assets in workspace

projectCountinteger

Number of projects in workspace

templateCountinteger

Number of templates in workspace

userCountinteger

Number of users in workspace

createdByEmailstring(email)

Email of workspace creator

brandingobject(UserBranding)

User's branding configuration for video creation

Response
application/json
{
  "id": "693fb82afd8d1c43077ba0fe",
  "name": "My Workspace",
  "assetCount": 4,
  "projectCount": 3,
  "userCount": 1,
  "templateCount": 1,
  "createdByEmail": "info@shuffll.com",
  "branding": {
    "isDefault": true,
    "enabled": true,
    "company": { … },
    "logo": "/files/platform/onboarding/logo-placeholder.svg",
    "logoW": "/files/platform/onboarding/logo-placeholder.svg",
    "colors": { … },
    "pronunciations": []
  }
}

Update workspace

Request

Update fields on a specific workspace.

Currently supports updating the workspace name. To update workspace branding (logo, colors, company info), use PUT /auth/branding/entity.

Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example: 693fb82afd8d1c43077ba0fb
workspaceIdstringrequired

Unique identifier for the workspace

Example: 693fb82afd8d1c43077ba0fe
Bodyapplication/jsonrequired
namestring

New display name for the workspace

Example: "Marketing Team Workspace"
curl -i -X PUT \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/693fb82afd8d1c43077ba0fe \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Marketing Team Workspace"
  }'

Responses

Workspace updated successfully.

Response
No content

List workspace projects

Request

Retrieve all projects in a specific workspace.

Returns a list of project summaries including each project's ID, name, current status, and creation date. Use this endpoint to enumerate existing projects before exporting or checking their status.

Security
ShuffllApiKey
Path
workspaceIdstringrequired

Unique identifier for the workspace

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

Responses

Successfully retrieved project list.

Bodyapplication/jsonArray [
idstring

Unique project identifier

Example: "6947b539cc95ea68854bb523"
namestring

Project name

Example: "Breaking the Agency Mold"
statusstring

Current project status

Enum"STRUCTURE""GENERATING_IMAGES""EDITING""DONE"
Example: "DONE"
createdAtstring(date-time)

Project creation timestamp

Example: "2025-12-15T07:26:34.333Z"
]
Response
application/json
[
  {
    "id": "6947b539cc95ea68854bb523",
    "name": "Breaking the Agency Mold",
    "status": "DONE",
    "createdAt": "2025-12-15T07:26:34.333Z"
  },
  {
    "id": "6947b539cc95ea68854bb524",
    "name": "Product Launch Q1 2026",
    "status": "EDITING",
    "createdAt": "2026-01-10T14:10:00.000Z"
  },
  {
    "id": "6947b539cc95ea68854bb525",
    "name": "Customer Success Stories",
    "status": "GENERATING_IMAGES",
    "createdAt": "2026-02-01T09:00:00.000Z"
  }
]

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